Saltar al contingut principal

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.
La teva clau d’API és un secret; tracta-la com una contrasenya.La clau principal proporciona accés complet a l’API en nom de la teva Aplicació. No l’exposis mai en codi de frontend, repositoris públics o paquets del costat del client. Mantén-la sempre exclusivament al costat del servidor.

Format de la clau d’API

Les claus d’API noves comencen amb sk_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 HTTP x-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 retorna 401 Unauthorized:
Una clau caducada també retorna 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.

Claus d’API amb àmbit

Dona a cada servei o soci la seva pròpia clau en lloc de compartir la principal. Cada clau té el seu propi accés: cap, lectura o escriptura per a cada recurs (sessions, decisions, fitxers multimèdia, persones, empreses, transaccions, fluxos de treball, webhooks, configuració de l’aplicació, analítica), i límits opcionals a determinats fluxos de treball, només a sessions aprovades, a una llista d’adreces IP i a una data de caducitat. Pots rotar una clau amb un solapament de 24 hores i revocar-la immediatament. Les claus creades abans que existís l’accés amb àmbit definit mantenen l’accés complet. Consulta Claus d’API per veure els valors predefinits, els recursos que cobreix cadascun i com respon l’API a una clau amb àmbit definit.
Si reps un error 401, torna a comprovar que estiguis utilitzant la clau d’API correcta per a l’Aplicació adequada i que no s’hagi regenerat.
Darrera modificació el 7 de novembre del 2026