Obter IDs pela API
Os usuários do Axe Monitor podem gerar uma chave de API na Conta Axe e consultar IDs que são necessários para uso com outros pontos de extremidade da API do Axe Monitor, sem utilizar a interface do usuário.
Saiba mais sobre Introdução.
Pontos de Extremidade
| Método | Ponto de Extremidade | Finalidade |
|---|---|---|
| GET | /lookups/presets |
Recupere IDs de predefinição para aplicar uma predefinição a uma verificação. E, quando uma verificação está atualmente atribuída a uma predefinição – descubra quais campos podem ser editados. |
| GET | /lookups/teams |
Obtenha nome da equipe e IDs para fornecer acesso às verificações via API. |
| GET | /lookups/scans |
Obtenha nomes e IDs das verificações para obter resultados, editar ou executar verificações. |
| GET | /scans/[scanId]/runs |
Liste todas as execuções de verificação para uma verificação, com informações gerais sobre a verificação. Permite que você recupere runId. |
| GET | /lookups/scan-groups |
Obtenha nomes e IDs de grupos de verificação para organizar verificações via API. |
| GET | /lookups/scripts |
Obtenha IDs para atribuir scripts compartilhados às verificações via API. |
Predefinições
Você pode aplicar as configurações de predefinição a uma verificação via API, mas o ID e o nome da predefinição são necessários primeiro. Use este ponto de extremidade para consultá-los.
O ID da predefinição também é necessário para entender quais configurações de verificação são editáveis quando uma predefinição já está aplicada.
Exemplo de Solicitação
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/presets
X-API-Key: <your_api_key>
Content-Type: application/jsonExemplo de Resposta
Status: 200 Sucesso
{
"presets": [
{ "id": 3, "name": "Gov Baseline" },
{ "id": 1, "name": "Marketing sites" }
]
}Equipes
Você pode atribuir permissões de equipe ao criar ou editar uma verificação via API. Use este ponto de extremidade para consultar nomes e IDs de equipe.
Exemplo de Solicitação
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/teams
X-API-Key: <your_api_key>
Content-Type: application/jsonExemplo de Resposta
Status: 200 Sucesso
{
"teams": [
{ "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "Accessibility" },
{ "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "Web Platform" }
]
}Verificações
IDs e nomes de verificação são necessários para obter resultados, editar e executar verificações. Use este ponto de extremidade para consultá-los.
Exemplo de Solicitação
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scans
X-API-Key: <your_api_key>
Content-Type: application/jsonExemplo de Resposta
Status: 200 Sucesso
{
"teams": [
{ "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "French Marketing Site" },
{ "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "My Account Platform" }
]
}Execuções de Verificação
IDs de execução de verificação podem ser recuperados com este ponto de extremidade para obter dados de resultados detalhados.
Exemplo de Solicitação
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>Exemplo de Resposta
{
"scanRuns": [
{
"runNumber": 1,
"status": "Completed",
"queuedAt": "2025-08-21T06:50:27Z",
"startedAt": "2025-08-21T06:50:37Z",
"completedAt": "2025-08-21T06:51:52Z",
"axeVersion": "4.10.3",
"standard": "WCAG 2.1 AA",
"score": 0,
"issues": {
"total": 392,
"critical": 77,
"serious": 315,
"moderate": 0,
"minor": 0
},
"pages": {
"total": 18,
"completed": 17,
"critical": 17
},
"violationGroups": [
{
"name": "color",
"pageCount": 17
},
{
"name": "forms",
"pageCount": 17
},
{
"name": "name-role-value",
"pageCount": 10
},
{
"name": "parsing",
"pageCount": 1
},
{
"name": "text-alternatives",
"pageCount": 13
}
]
}
]
}Grupos de Verificação
Você pode organizar verificações por grupos de verificação ao criar ou editar verificações a partir da API. Use este ponto de extremidade para consultar IDs e nomes de grupos de verificação.
Exemplo de Solicitação
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scan-groups
X-API-Key: <your_api_key>
Content-Type: application/jsonExemplo de Resposta
Status: 200 Sucesso
{
"scanGroups": [
{ "id": 1234, "name": "Marketing" },
{ "id": 1200, "name": "Storefront" }
]
}Scripts Compartilhados
Scripts compartilhados que estão armazenados na seção de Administração do Axe Monitor e usados em várias verificações podem ser aplicados ao criar ou editar verificações via API. Use este ponto de extremidade para consultar IDs de scripts compartilhados.
Exemplo de Solicitação
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scripts
X-API-Key: <your_api_key>
Content-Type: application/jsonExemplo de Resposta
Status: 200 Sucesso
{
"scripts": [
{ "id": 12, "name": "Dismiss cookie banner", "type": "TASK" },
{ "id": 9, "name": "SSO login", "type": "SESSION" }
]
}