ApiKeyController

Informações de API Keys

Endpoint: /apikey

method: POST

path: /apikey

description: Endpoint para createApiKey

parameters:
  - name: request
    type: CreateApiKeyRequest
    description: Parâmetro request
    required: true
    in: body

Exemplo de requisição:

curl --request POST \
  --url https://<url>/apikey \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>' \
  -d '{
    "safraId": "<id_safra>",
    "safraCodigo": "<codigo_safra>",
    "dados": {
      ...
    }
  }'

Exemplo de resposta:

{
    "status": "success",
    "message": "Operação realizada com sucesso",
    "data": {}
}

Exemplo de erro:

{
    "status": "error",
    "message": "Erro na operação",
    "code": 500
}

Endpoint: /apikey

method: GET

path: /apikey

description: Endpoint para getAllApiKeys

parameters:
  - 
  -

Exemplo de requisição:

curl --request GET \
  --url https://<url>/apikey \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>'

Exemplo de resposta:

{
    "status": "success",
    "message": "Operação realizada com sucesso",
    "data": {}
}

Exemplo de erro:

{
    "status": "error",
    "message": "Erro na operação",
    "code": 500
}

Endpoint: /apikey/{accessKey}

method: DELETE

path: /apikey/{accessKey}

description: Endpoint para deactivateApiKey

parameters:
  - name: accessKey
    type: String
    description: Parâmetro accessKey
    required: true
    in: path

Exemplo de requisição:

curl --request DELETE \
  --url https://<url>/apikey/{accessKey} \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>'

Exemplo de resposta:

{
    "status": "success",
    "message": "Operação realizada com sucesso",
    "data": {}
}

Exemplo de erro:

{
    "status": "error",
    "message": "Erro na operação",
    "code": 500
}