Tokens

O módulo Tokens: sincronização de tokens para autorização por lista branca, métodos por papel e o objeto Token.

Nesta página

Considerações técnicas

O EMSP deve garantir que os tokens necessários para a autorização baseada em lista branca (whitelist) estão corretamente sincronizados com o MOBI.Hub sempre que este modelo de autorização for usado.

O MOBI.Hub suporta tanto a autorização baseada em lista branca como a autorização em tempo real, consoante o modelo de operação escolhido pelo EMSP. Num modelo de Hub Clássico, a informação dos tokens pode ser trocada e gerida de acordo com os fluxos OCPI aplicáveis. Num modelo de Autenticação Centralizada com autorização em tempo real, os tokens não precisam de ser sincronizados com o MOBI.Hub, uma vez que a autorização é feita junto do EMSP em tempo real.

O MOBI.Hub PODE fazer um pedido GET para obter a lista completa de tokens disponíveis para um dado EMSP quando é usada a autorização baseada em lista branca. No entanto, o MOBI.Hub não tem a obrigação de fazer esta operação e o EMSP deve garantir que a informação dos tokens disponibilizada ao HUB se mantém atualizada.

A criação ou atualização de tokens não é necessariamente encaminhada diretamente para os CPO. Consoante o modelo de autorização escolhido e os fluxos OCPI aplicáveis, a informação dos tokens pode ser usada pelo MOBI.Hub para efeitos de autorização sem que o CPO tenha de receber o objeto Token completo.

Métodos a implementar

MOBI.Hub – Receiver

Métodos de `Tokens` para o MOBI.Hub – Receiver
Método	Direção	Descrição da utilização
`GET`	Resposta	O EMSP deve poder obter os seus tokens tal como estão definidos no MOBI.Hub.
`PUT`	Resposta	O EMSP deve poder criar um novo token ou atualizar um token existente
`PATCH`	Resposta	Atualizar parcialmente o token

EMSP – Sender

Métodos de `Tokens` para o EMSP – Sender
Método	Direção	Descrição da utilização
`GET`	Pedido	O EMSP deve poder obter os seus tokens
`PUT`	Pedido	O EMSP deve poder criar um novo token ou atualizar um token existente
`PATCH`	Pedido	Atualizar parcialmente o token

Descrição dos objetos

Descrição do objeto Token:

Propriedades do objeto `Token`
Propriedade	Obrigatório	Valor	Comentários
`country_code`	TRUE	`PT`
`party_id`	TRUE
`uid`	TRUE		`internal_number` se `type=RFID`. Neste caso, deve ser considerado o formato decimal direto. Se o tipo for `AD_HOC_USER` ou `APP_USER`, é aconselhável usar um inteiro com menos de 19 dígitos. Para garantir a unicidade, recomenda-se o seguinte formato: concatenação entre a hora atual em milissegundos (13 dígitos) e 5 dígitos aleatórios. Isto não é obrigatório. Caso um `uid` já exista e não pertença ao EMSP, o MOBI.Hub responde com uma mensagem de erro.
`type`	TRUE	`AD_HOC_USER` `APP_USER` `RFID`
`contract_id`	TRUE		<Country Code> = “AA” <Party ID> = “AAA” <Separator> = - <ID Type> = “C” -<eMA Instance> = 8 (ALPHA / DIGIT) Cada EMSP é totalmente livre de definir as suas estruturas alfanuméricas de 8 caracteres para os seus contratos de mobilidade elétrica. Por exemplo, um contrato de mobilidade elétrica MOB codificado com “1234ABCD” teria o `contract_ID` correspondente: `PT-MOB-C1234ABCD-J`. O dígito de controlo é opcional, mas, se for usado, tem de estar correto.
`issuer`	TRUE		Nome do emissor do cartão/token. Pode ser definido livremente pelo EMSP.
`valid`	TRUE
`whitelist`	TRUE
`last_updated`	TRUE