Introdução

Portal de APIs

Integre seus sistemas à Oslo DTVM

Começar pela autenticação Ver a referência

O que são as APIs

A Oslo DTVM disponibiliza APIs REST para que parceiros integrem seus sistemas aos serviços da empresa. Hoje há três APIs:

API	Para que serve	Referência
Autenticação	Emite os tokens de acesso usados nas demais APIs.	Referência
Workflow	Cria e consulta tarefas nos fluxos de trabalho.	Referência
Cadastro	Consulta o cadastro de clientes.	Referência

Todas as chamadas usam HTTPS. Os dados são trocados em JSON, exceto a emissão de token, que usa application/x-www-form-urlencoded.

URL base

O ambiente atualmente disponível é o de desenvolvimento:

https://apim-oslodtvm-dev.azure-api.net

Cada API tem seu próprio caminho a partir da URL base:

API	URL
Autenticação	`https://apim-oslodtvm-dev.azure-api.net/auth/v1`
Workflow	`https://apim-oslodtvm-dev.azure-api.net/workflow/v1`
Cadastro	`https://apim-oslodtvm-dev.azure-api.net/cadastro/v1`

URL do ambiente de produção: a definir.

Versionamento

A versão da API faz parte do caminho: /v1 em todas as URLs acima. Uma versão nova será publicada em um caminho novo (por exemplo, /v2), sem alterar a versão em uso.

Política de descontinuação de versões e prazos de aviso: a definir.

Primeiros passos

Obtenha suas credenciais (client_id e client_secret) e sua chave de assinatura. Como solicitá-las: a definir.
Siga o guia de Autenticação para obter um token.
Chame as APIs de negócio. Em caso de problema, veja Erros e Suporte.