curl --request POST \
--url https://api.id.zapsign.com.br/v1/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Integração backend"
}
'{
"object": "api_key",
"id": "key_0VH6KAMHAE8HTD08DB9XVZEN3P",
"token": "sk_XhhtZoudJBibSS7-r2GwZicaCzhrbY9ZZxrIC4ESrjc"
}{
"error": {
"type": "invalid_request",
"code": "missing_required_param",
"message": "A required parameter is missing.",
"param": "cpf",
"doc_url": "https://docs.id.zapsign.com.br/missing_required_param",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4"
}
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "The API key provided is invalid.",
"doc_url": "https://docs.id.zapsign.com.br/invalid_api_key",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4"
}
}{
"error": {
"type": "invalid_request",
"code": "insufficient_permission",
"message": "The API key does not have permission to perform this action.",
"doc_url": "https://docs.id.zapsign.com.br/insufficient_permission",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4"
}
}{
"error": {
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "Too many requests. Please retry after the indicated delay.",
"doc_url": "https://docs.id.zapsign.com.br/rate_limit_exceeded",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4"
}
}{
"error": {
"type": "api_error",
"code": "api_error",
"message": "An internal error occurred.",
"doc_url": "https://docs.id.zapsign.com.br/api_error",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4"
}
}Chaves de API
Criar chave de API
O token completo aparece uma única vez, nesta resposta. Guarde antes de fechar. Este endpoint não aceita Idempotency-Key: cada chamada cria uma chave nova.
POST
/
api-keys
curl --request POST \
--url https://api.id.zapsign.com.br/v1/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Integração backend"
}
'{
"object": "api_key",
"id": "key_0VH6KAMHAE8HTD08DB9XVZEN3P",
"token": "sk_XhhtZoudJBibSS7-r2GwZicaCzhrbY9ZZxrIC4ESrjc"
}{
"error": {
"type": "invalid_request",
"code": "missing_required_param",
"message": "A required parameter is missing.",
"param": "cpf",
"doc_url": "https://docs.id.zapsign.com.br/missing_required_param",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4"
}
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "The API key provided is invalid.",
"doc_url": "https://docs.id.zapsign.com.br/invalid_api_key",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4"
}
}{
"error": {
"type": "invalid_request",
"code": "insufficient_permission",
"message": "The API key does not have permission to perform this action.",
"doc_url": "https://docs.id.zapsign.com.br/insufficient_permission",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4"
}
}{
"error": {
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "Too many requests. Please retry after the indicated delay.",
"doc_url": "https://docs.id.zapsign.com.br/rate_limit_exceeded",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4"
}
}{
"error": {
"type": "api_error",
"code": "api_error",
"message": "An internal error occurred.",
"doc_url": "https://docs.id.zapsign.com.br/api_error",
"request_id": "req_3PK3TA2H0MEMTDSAPREHSY4QC4"
}
}Authorizations
Sua chave de API no cabeçalho Authorization: Bearer sk_.... Crie e revogue chaves no painel ou pelos endpoints de Chaves de API.
Body
application/json
Dados para criar uma chave de API.
Nome para identificar a chave depois.
Required string length:
1 - 50Example:
"Integração backend"
Escopo da chave. Se você omitir, vale validations_access.
| Valor | O que permite |
|---|---|
validations_access | Criar e consultar validações |
full_access | O mesmo, mais gerenciar chaves de API |
Available options:
validations_access, full_access Response
Chave criada; o token é retornado uma única vez.
Resposta da criação: o id da chave e o token completo, que aparece uma única vez.
Sempre api_key.
Available options:
api_key Identificador único da chave criada.
Example:
"key_0VH6KAMHAE8HTD08DB9XVZEN3P"
O token secreto. Guarde agora: esta é a única resposta que o traz.
Example:
"sk_XhhtZoudJBibSS7-r2GwZicaCzhrbY9ZZxrIC4ESrjc"
Was this page helpful?