Trobar la clau d’API
A Didit, les claus d’API tenen un àmbit definit a una Aplicació específica dins del teu compte. Una Aplicació és un espai de treball on pots configurar fluxos de treball i gestionar verificacions per a un projecte o entorn determinat. Cada Aplicació rep una clau d’API principal amb accés complet quan la crees. Pots afegir-hi més claus, cadascuna només amb l’accés que necessiti un servei o soci. Per trobar les teves claus:1
Inicia sessió a la Business Console
Ves a la Didit Business Console i inicia sessió.
2
Selecciona la teva Aplicació
Tria l’Aplicació amb la qual vols treballar al menú desplegable superior.
3
Obre les claus d'API
Navega a Desenvolupadors -> Claus d’API a la barra lateral esquerra.
4
Copia o crea una clau
La clau Principal és el secret propi de l’Aplicació. Crea una clau nova per donar a un servei o soci el seu propi secret, amb l’accés que necessiti.
Format de la clau d’API
Les claus d’API noves comencen ambsk_live_ per a una aplicació en producció o sk_test_ per a una aplicació en sandbox, seguides de 43 caràcters segurs per a URL (lletres, dígits, - i _).
Les claus creades abans d’aquest format no tenen prefix i continuen funcionant sense canvis.
Envia la clau sencera, prefix inclòs, a la capçalera x-api-key, i no rebutgis cap clau pel fet de no tenir prefix.
Trobar el teu ID d’organització
El teu ID de l’organització és l’UUID que identifica la teva organització. El fas servir en rutes d’API d’àmbit d’organització com ara/auth/v2/organizations/me/{org_id}/applications/. Pots copiar-lo directament des de la Business Console, sense necessitat de cap crida a l’API:
1
Obre la configuració de l'organització
A la Didit Business Console, ves a Configuració de l’organització.
2
Copia l'ID de l'organització
El camp ID de l’organització mostra l’UUID de la teva organització al costat del nom de l’organització, amb un botó per copiar al porta-retalls.
Fer sol·licituds autenticades
Per autenticar una sol·licitud a l’API, inclou la teva clau d’API secreta a la capçalera HTTPx-api-key.
A continuació tens un exemple d’una sol·licitud autenticada a l’endpoint Create Session:
cURL
Gestió d’errors
Si la teva clau d’API és incorrecta, està mal formada o s’ha revocat, l’API retorna401 Unauthorized:
401, amb "detail": "This API key has expired.".
Una sol·licitud sense clau retorna 403 amb "detail": "You do not have permission to perform this action.".
La pàgina d’errors de l’API enumera tots els estats, cossos i codis.