Manual para integração da API - revisão 201510/01

Manual para integração da API

Esta API permite que desenvolvedores integrem seus sistemas diretamente ao
OriginalMy.com, utilizando uma interface HTTP, através de duas interfaces por POST:

● https://originalmy.com/api/v1/company/register​: usada para registrar o

hash SHA256 de um novo documento.
● https://originalmy.com/api/v1/company/dev-register​: usada para
simular o registro de um hash SHA256 de um documento (homologação).
● https://originalmy.com/api/v1/status​: recebe o hash SHA256 e retorna o
status do documento.

Exemplo:
Utilize as ferramentas de cálculo de hash SHA256 do ambiente de programação do seu
projeto para calcular o hash SHA256 do documento que deseja certificar no Blockchain.

Ex. no Mac: # shasum -a 256 <arquivo> | No Linux: # sha256sum <arquivo>

1dfa718728cb9ad03a5dcca8bffb9087dc4d09b012d60fc1688c7b7ec51134cf <arquivo>

Checando o status do registro

Método: POST
Endereço: https://originalmy.com/api/v1/status
Parâmetros:
● d=<SHA256_do_arquivo>

Retorno (JSON):
success true: ok
false: erro

status pending: pendente de pagamento,

sent: transação enviada ao blockchain,
confirmed: transação confirmada no
blockchain

reason format: erro no formato da string,

nonexistent: hash não registrado,

blockstamp timestamp da confirmação no blockchain

txstamp timestamp do envio para o blockchain

transaction código da transação

2015 - OriginalMy.com
 Manual para integração da API - revisão 201510/01

Exemplo de uso no shell:

# curl \
-d d=1dfa718728cb9ad03a5dcca8bffb9087dc4d09b012d60fc1688c7b7ec51134cf \
https://originalmy.com/api/v1/status; echo
{
"status": "confirmed",
"blockstamp": "2015-10-05 06:02:06",
"transaction":
"f5fe0263dca81dbb53350ee245794ffb9e69776530d6dc57fc0aca899c1e280a",
"txstamp": "2015-10-05 06:00:03",
"success": true
}

Enviando um documento para registro

Método: POST
Endereço: ​https://originalmy.com/api/v1/company/register
(para ambiente de homologação utilizar:
https://originalmy.com/api/v1/company/dev-register​)
Parâmetros:
● d=<SHA256_do_arquivo>
● k=<chave_de_acesso>

Retorno (JSON):
success true: ok
false: erro

reason format: erro no formato da string

existing: SHA256 já registrado

digest SHA256 do arquivo enviado

quota número de registros disponíveis

Exemplo de uso no shell:

# curl \
-d d=1dfa718728cb9ad03a5dcca8bffb9087dc4d09b012d60fc1688c7b7ec51134cf \
-d k=<chave_de_acesso> https://originalmy.com/api/v1/company/register; echo
{
"digest": "1dfa718728cb9ad03a5dcca8bffb9087dc4d09b012d60fc1688c7b7ec51134cf",
"success": true,
"quota": 99
}

2015 - OriginalMy.com