API docs by Redocly

Plataforma Kaspper InterOps API (0.7.1)

Download OpenAPI specification:Download

E-mail: contato@kaspper.com

API para garantir interoperabilidade entre sistemas antifraude. Solução desenvolvida pelas Kaspper.

Projeto em desenvolvimento.

Pendências:

  • Definições de assinaturas
  • Respostas
  • Segurança
  • Mocks
  • Verificação de boas práticas
  • Validação dos verbos adequados
  • Validar Kanbam com as atividades

route

Operações de Rotas

Cadastro de documento para rota e chamada de webhook

Request Body schema: application/json
required
document
string

Responses

Request samples

Content type
application/json
{
  • "document": "string"
}

Cadastro em Lote de Documentos para Rota e chamada de webhook

Request Body schema: application/json
required
documents
Array of strings

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Consulta Documento

path Parameters
document
required
string

Responses

Remoção de Documento das Rotas

path Parameters
document
required
string

Responses

Consulta Documentos em Lote

path Parameters
documents
required
Array of strings

Responses

Remoção em Lote de Documentos para Rota

path Parameters
documents
required
Array of strings

Responses

bureau

Operações de informações da Casa

Consulta dados da Casa

path Parameters
id
required
string

Responses

Atualização de Webhook

path Parameters
id
required
string
Request Body schema: application/json
required
urlWebhook
string

Responses

Request samples

Content type
application/json
{
  • "urlWebhook": "string"
}

audit

Operações de Auditoria

Consulta Logs de Auditoria

query Parameters
startDate
required
string <date>

Data de início do período (formato YYYY-MM-DD)

endDate
required
string <date>

Data de fim do período (formato YYYY-MM-DD)

regType
required
string

Responses

dashboard

Operações utilizadas para construção de dashboard

Consulta Indicadores de contribuição

query Parameters
periodo
required
string

Responses

Consulta Volumetria

query Parameters
startDate
required
string <date>

Data de início do período (formato YYYY-MM-DD)

endDate
required
string <date>

Data de fim do período (formato YYYY-MM-DD)

Responses