URI Base

A API de Trilhas usa o seguinte caminho base:

https://pathways-core.niduu.com/v1/public

Autenticação

A autenticação na API é feita através do Bearer access tokens (RFC 6750).
A cada requisição, o header de "Authorization" precisa ser enviado. Por exemplo:

GET /v1/public/pathways
Host: pathways-core.niduu.com
Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

📘
Como eu gero o Access Token?
Você pode gerar o token através da plataforma Administrativa de Educação Corporativa acessando o menu de Configurações > API Trilhas.

❗️
Não exponha seu Token
Nunca exponha seu token de acesso na Internet e trate-o como trataria sua senha. Lembre-se de que a posse do seu token pode permitir que usuários mal-intencionados tomem qualquer ação na plataforma Educação Corporativa. Por esse motivo, a API não expõe cabeçalhos CORS.

Paginação

Os endpoints de listagem oferecem opção de paginação que pode ser feito através dos parâmetros querystring abaixo:

Parameter	Description
maxPageSize	Número máximo de itens numa página, o padrão é 10, podendo ser alterado até 100. O resultado pode ter menos itens que o passado no parâmetro.
pageToken	Token para acessar a próxima página. Usado depois da primeira request quando iterando pelas páginas.

A resposta dos endpoints de listagem terão a seguinte propriedade de controle:

Property	Description
nextPageToken	O token para acessar a próxima página. Esse token precisa ser enviado como parâmetro "pageToken" na querystring, para acessar a próxima página.

Formato de resposta

A API responde no formato JSON.
Nos endpoints que o resultado é um item o dado estará dentro da propriedade result no corpo da resposta. Exemplo:

GET /v1/public/pathways/123
Host: pathways-core.niduu.com
Authorization: Bearer 1c3ce6b8251d91c1112aa11d1ef2daa1

{
  "result": {
  	"id": 36,
  	"name": "Treinamento em uma habilidade",
    …
  }
}

Nos endpoints que o resultado é uma lista o dado estará dentro da propriedade results:

GET /v1/public/pathways
Host: pathways-core.niduu.com
Authorization: Bearer 1c3ce6b8251d91c1112aa11d1ef2daa1

{
  "results": [
    {
      "id": 36,
      "name": "Treinamento em uma habilidade",
      …
    },
    {
      "id": 37,
      "name": "Treinamento em outra habilidade",
      …
    },
  ],
  "nextPageToken": "abc123"
}