Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/foxnfe-com-br:foxnfe-com-br-certificates-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: FOX NF-e Certificates API
version: '1.20260923'
description: Contrato derivado das rotas, regras Laravel e respostas estáticas. Condições de validação são descritas nos campos. x-source identifica a evidência. Valores dinâmicos sem tipo comprovado não recebem tipos inventados.
servers:
- url: https://www.foxnfe.com.br
tags:
- name: Certificates
paths:
/api/v1/certificates:
get:
operationId: get_api_v1_certificates
tags:
- Certificates
summary: Certificate index
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:41
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- tenant.status
- plan.limits
responses:
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
data:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:51
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
data: null
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:51
security:
- bearerAuth: []
post:
operationId: post_api_v1_certificates
tags:
- Certificates
summary: Certificate store
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:63
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- tenant.status
- plan.limits
- throttle:10,60
- ability:certificates:write
responses:
'201':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
data:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:115
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
data: null
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:115
default:
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
error:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:117
message:
type: string
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: null
message: EXEMPLO_FICTICIO
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:117
'422':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
anyOf:
- type: object
properties:
error:
type: string
example: wrong_password
message:
type: string
- type: object
properties:
error:
type: string
example: expired_certificate
message:
type: string
- type: object
properties:
error:
type: string
example: cnpj_mismatch
message:
type: string
- type: object
properties:
error:
type: string
example: invalid_pfx
message:
type: string
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: wrong_password
message: EXEMPLO_FICTICIO
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:119
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:121
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:123
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:127
'409':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: duplicate
message:
type: string
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: duplicate
message: EXEMPLO_FICTICIO
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:125
'503':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: vault_unavailable
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: vault_unavailable
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:129
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/post_api_v1_certificatesRequest'
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
pfx: EXEMPLO_FICTICIO
password: EXEMPLO_FICTICIO
label: EXEMPLO_FICTICIO
/api/v1/certificates/rotate:
post:
operationId: post_api_v1_certificates_rotate
tags:
- Certificates
summary: Certificate rotate
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:145
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- tenant.status
- plan.limits
- throttle:10,60
- ability:certificates:write
responses:
'201':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
data:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:181
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
data: null
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:181
'422':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
anyOf:
- type: object
properties:
error:
type: string
example: wrong_password
message:
type: string
- type: object
properties:
error:
type: string
example: expired_certificate
message:
type: string
- type: object
properties:
error:
type: string
example: cnpj_mismatch
message:
type: string
- type: object
properties:
error:
type: string
example: invalid_pfx
message:
type: string
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: wrong_password
message: EXEMPLO_FICTICIO
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:183
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:185
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:187
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:191
'409':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: duplicate
message:
type: string
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: duplicate
message: EXEMPLO_FICTICIO
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:189
'503':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: vault_unavailable
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: vault_unavailable
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:193
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/post_api_v1_certificates_rotateRequest'
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
pfx: EXEMPLO_FICTICIO
password: EXEMPLO_FICTICIO
label: EXEMPLO_FICTICIO
/api/v1/certificates/validate:
post:
operationId: post_api_v1_certificates_validate
tags:
- Certificates
summary: Certificate validate
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:134
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- tenant.status
- plan.limits
responses:
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
data:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:137
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
data: null
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:137
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/post_api_v1_certificates_validateRequest'
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
pfx: EXEMPLO_FICTICIO
password: EXEMPLO_FICTICIO
label: EXEMPLO_FICTICIO
/api/v1/certificates/{id}:
get:
operationId: get_api_v1_certificates__id_
tags:
- Certificates
summary: Certificate show
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:54
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- tenant.status
- plan.limits
responses:
'404':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: not_found
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: not_found
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:58
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
data:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:60
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
data: null
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:60
security:
- bearerAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: integer
pattern: '[0-9]+'
delete:
operationId: delete_api_v1_certificates__id_
tags:
- Certificates
summary: Certificate destroy
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:223
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- tenant.status
- plan.limits
- ability:certificates:write
responses:
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: revoked
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
status: revoked
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:227
'404':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: not_found
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: not_found
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:227
security:
- bearerAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: integer
pattern: '[0-9]+'
/api/v1/certificates/{id}/revoke:
post:
operationId: post_api_v1_certificates__id__revoke
tags:
- Certificates
summary: Certificate revoke
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:214
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- tenant.status
- plan.limits
- ability:certificates:write
responses:
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: revoked
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
status: revoked
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:219
'404':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: not_found_or_already_revoked
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: not_found_or_already_revoked
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:220
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/post_api_v1_certificates__id__revokeRequest'
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
reason: EXEMPLO_FICTICIO
parameters:
- name: id
in: path
required: true
schema:
type: integer
pattern: '[0-9]+'
/api/v1/certificates/{id}/recover:
post:
operationId: post_api_v1_certificates__id__recover
tags:
- Certificates
summary: Certificate recover
x-source: app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:202
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- tenant.status
- plan.limits
- ability:certificates:write
responses:
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
anyOf:
- type: object
properties:
status:
type: string
example: recovered
- type: object
properties:
status:
type: string
example: already_active
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
status: recovered
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:207
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:208
'422':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: recovery_denied
message:
type: string
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: recovery_denied
message: EXEMPLO_FICTICIO
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:210
security:
- bearerAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: integer
pattern: '[0-9]+'
components:
schemas:
post_api_v1_certificates__id__revokeRequest:
type: object
properties:
reason:
x-laravel-rules:
- required
- string
- max:1000
type: string
maxLength: 1000
required:
- reason
x-source:
- app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:216
post_api_v1_certificates_rotateRequest:
type: object
properties:
pfx:
x-laravel-rules:
- required
- string
- max:1500000
type: string
maxLength: 1500000
password:
x-laravel-rules:
- required
- string
type: string
label:
x-laravel-rules:
- required
- string
- max:255
type: string
maxLength: 255
cnpj_override:
x-laravel-rules:
- nullable
- string
- regex:/^\d{14}$|^[A-Z0-9]{14}$/
type:
- string
- 'null'
pattern: ^\d{14}$|^[A-Z0-9]{14}$
company_id:
x-laravel-rules:
- nullable
- integer
- min:1
type:
- integer
- 'null'
minimum: 1
required:
- pfx
- password
- label
x-source:
- app/app/Modules/Security/Certificate/Http/Requests/CertificateUploadRequest.php:13
post_api_v1_certificates_validateRequest:
type: object
properties:
pfx:
x-laravel-rules:
- required
- string
- max:1500000
type: string
maxLength: 1500000
password:
x-laravel-rules:
- required
- string
type: string
label:
x-laravel-rules:
- required
- string
- max:255
type: string
maxLength: 255
cnpj_override:
x-laravel-rules:
- nullable
- string
- regex:/^\d{14}$|^[A-Z0-9]{14}$/
type:
- string
- 'null'
pattern: ^\d{14}$|^[A-Z0-9]{14}$
company_id:
x-laravel-rules:
- nullable
- integer
- min:1
type:
- integer
- 'null'
minimum: 1
required:
- pfx
- password
- label
x-source:
- app/app/Modules/Security/Certificate/Http/Requests/CertificateUploadRequest.php:13
post_api_v1_certificatesRequest:
type: object
properties:
pfx:
x-laravel-rules:
- required
- string
- max:1500000
type: string
maxLength: 1500000
password:
x-laravel-rules:
- required
- string
type: string
label:
x-laravel-rules:
- required
- string
- max:255
type: string
maxLength: 255
cnpj_override:
x-laravel-rules:
- nullable
- string
- regex:/^\d{14}$|^[A-Z0-9]{14}$/
type:
- string
- 'null'
pattern: ^\d{14}$|^[A-Z0-9]{14}$
company_id:
x-laravel-rules:
- nullable
- integer
- min:1
type:
- integer
- 'null'
minimum: 1
required:
- pfx
- password
- label
x-source:
- app/app/Modules/Security/Certificate/Http/Requests/CertificateUploadRequest.php:13
securitySchemes:
bearerAuth:
type: http
scheme: bearer