API
API
Utilize a referência interativa da API do DocID® para as Business Resources suportadas.
A DocID® Business API está documentada através de uma interface Swagger interativa.
Abrir a referência interativa da API
O documento OpenAPI legível por máquina está disponível em:
https://docid.pro/api/openapi.jsonAPI e OAuth
Utilize os endpoints OAuth 2.0 para autenticar um visitante do site e obter as informações de identidade autorizadas.
Utilize a Business API para as Management Resources e Application Resources descritas no documento OpenAPI. Os Authentication Requirements, Request Schemas, Responses e Error Codes são especificados por operação na referência interativa.
Utilização segura da API
- Efetue chamadas a operações privilegiadas a partir de código server-side de confiança.
- Utilize as credenciais destinadas ao ambiente atual.
- Valide cada response e trate os Status Codes que não indiquem sucesso.
- Não registe Authorization Headers nem Response Data sensíveis.
- Utilize os identifiers documentados em vez de inferir Resource Relationships.