MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include a query parameter api_token in the request.

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting the administrative panel and clicking on your profile photo.

Endpoints

GET api/vtm

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/vtm?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_VTMID": "@brasil12503336932",
        "NO_NM": "Abemaciclibe"
    },
    {
        "NU_VTMID": "@brasil13049573527",
        "NO_NM": "Ácido Fólico + Dextroalfatocoferol"
    },
    {
        "NU_VTMID": "@brasil11336386157",
        "NO_NM": "AMOCIXILINA TRIHIDRATADA"
    },
    {
        "NU_VTMID": "@brasil17340852306",
        "NO_NM": "Betametasona + Ácido Salicílico"
    }
]

Request   

GET api/vtm

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_VTMID,NO_NM

Must be one of:
  • NU_VTMID
  • NO_NM
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_VTMID   string   

O Código OBM do VTM

NO_NM   string   

O Nome do VTM

GET api/vmp

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/vmp?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_VPID": "@brasil3731275719",
        "NO_NM": "Abacavir 20 mg/mL solução oral"
    },
    {
        "NU_VPID": "@brasil0593132159",
        "NO_NM": "Abacavir 300mg comprimido revestido"
    },
    {
        "NU_VPID": "@brasil14258676378",
        "NO_NM": "Abacavir 600 mg + Lamivudina 300 mg comprimido"
    },
    {
        "NU_VPID": "@brasil15224574230",
        "NO_NM": "Abatacepte 125 mg/1 mL solução para injeção; seringa preenchida"
    }
]

Request   

GET api/vmp

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_VPID,NO_NM

Must be one of:
  • NU_VPID
  • NO_NM
  • NU_CATMAT
  • CO_UDFS_UOMCD
  • CO_DF_INDCD
  • QT_UDFS
  • CO_UNIT_DOSE_UOMCD
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_VPID   string   

O Código OBM do VMP

NO_NM   string   

O Nome do VMP

NU_CATMAT      

O(s) código(s) CATMAT do VMP

CO_FORMCD      

Forma(s) farmacêutica(s) do VMP (Chave estrangeira)

CO_DF_INDCD      

Indicador da Dose Unitária do VMP (Chave estrangeira)

QT_UDFS      

Quantidade da Dose Unitária do VMP

CO_UNIT_DOSE_UOMCD      

Unidade de Medida da Qtd. da Dose Unitária do VMP (Chave estrangeira)

GET api/vmpp

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/vmpp?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_VPPID": "@brasil14763029701",
        "NO_NM": "Abacavir 20 mg/mL solução oral x 240 mL",
        "QT_QTYVAL": 240,
        "CO_QTY_UOMCD": "11181 - mL (Mililitro)"
    },
    {
        "NU_VPPID": "@brasil6592990206",
        "NO_NM": "Abacavir 300mg comprimido revestido x 60 comprimidos",
        "QT_QTYVAL": 60,
        "CO_QTY_UOMCD": "11207 - comprimido"
    },
    {
        "NU_VPPID": "@brasil79111710938",
        "NO_NM": "Abacavir 600 mg + Lamivu…rimido x 30 comprimidos",
        "QT_QTYVAL": 30,
        "CO_QTY_UOMCD": "11207 - comprimido"
    },
    {
        "NU_VPPID": "@brasil34102960097",
        "NO_NM": "Abatacepte 125 mg/1 mL s… preenchida x 1 seringa",
        "QT_QTYVAL": 1,
        "CO_QTY_UOMCD": "11206 - seringa"
    }
]

Request   

GET api/vmpp

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_VPPID,NO_NM

Must be one of:
  • NU_VPPID
  • NO_NM
  • QT_QTYVAL
  • CO_QTY_UOMCD
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_VPPID   string   

O Código OBM do VMPP

NO_NM   string   

O Nome do VMPP

QT_QTYVAL   number   

Valor da quantidade, peso ou volume de distribuição

CO_QTY_UOMCD   string   

Unidade de medida da quantidade, peso ou volume (Chave estrangeira)

GET api/amp

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/amp?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_APID": "@brasil41592239750",
        "NO_NM": "AAS 500 mg comprimido (SANOFI-AVENTIS FARMACÊUTICA LTDA)"
    },
    {
        "NU_APID": "@brasil41516646362",
        "NO_NM": "AAS Infantil 100 mg comprimido (SANOFI-AVENTIS FARMACÊUTICA LTDA)"
    },
    {
        "NU_APID": "@brasil41850594531",
        "NO_NM": "AAS Protect 100 mg comprimido gastrorresistente (COSMED INDUSTRIA DE COSMETICOS E MEDICAMENTOS S.A.)"
    },
    {
        "NU_APID": "@brasil41172062794",
        "NO_NM": "Abba 250 mg comprimido revestido (SUN FARMACÊUTICA DO BRASIL LTDA)"
    }
]

Request   

GET api/amp

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_APID,NO_NM

Must be one of:
  • NU_APID
  • NO_NM
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_APID   string   

O Código OBM do AMP

NO_NM   string   

O Nome do AMP

GET api/ampp

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/ampp?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_APPID": "@brasil51100781719",
        "NO_NM": "AAS 100 mg comprimido (COSMED INDUSTRIA DE COSMETICOS E MEDICAMENTOS S.A.) x 200 comprimidos"
    },
    {
        "NU_APPID": "@brasil51095068538",
        "NO_NM": "AAS 100 mg comprimido (COSMED INDUSTRIA DE COSMETICOS E MEDICAMENTOS S.A.) x 30 comprimidos"
    },
    {
        "NU_APPID": "@brasil51927237522",
        "NO_NM": "AAS Protect 100 mg comprimido gastrorresistente (COSMED INDUSTRIA DE COSMETICOS E MEDICAMENTOS S.A.) x 30 comprimidos"
    },
    {
        "NU_APPID": "@brasil51084809960",
        "NO_NM": "Abba 250 mg comprimido revestido (SUN FARMACÊUTICA DO BRASIL LTDA) x 120 comprimidos"
    }
]

Request   

GET api/ampp

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_APPID, NO_NM

Must be one of:
  • NU_APPID
  • NO_NM
  • NU_SANREG
  • NU_CATMAT
  • CO_SUPPCD
  • NU_EAN13a
  • NU_EAN13b
  • NU_EAN13c
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME
  • NU_SANREG
  • NU_EAN13

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_APPID   string   

O Código OBM do AMPP

NO_NM   string   

O Nome do AMPP

NU_CATMAT      

O(s) código(s) CATMAT do VMP do AMPP

CO_SUPPCD      

O CNPJ e a Descrição da Indústria do AMPP

NU_SANREG      

O Número de Registro Sanitário

NU_EAN13a      

O Código de Barras primário

NU_EAN13b      

O Código de Barras secundário

GET api/flavour

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/flavour?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_CD": "@brasil00416684224",
        "NO_DESCR_PT_BR": "abacaxi"
    },
    {
        "NU_CD": "@brasil00410054907",
        "NO_DESCR_PT_BR": "amora preta"
    },
    {
        "NU_CD": "@brasil00415842256",
        "NO_DESCR_PT_BR": "arroz e limão"
    },
    {
        "NU_CD": "@brasil00417309826",
        "NO_DESCR_PT_BR": "banana"
    }
]

Request   

GET api/flavour

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD   string   

O Código OBM do VTM

NO_DESCR_PT_BR   string   

O Nome do VTM

GET api/form

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/form?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_CD": "@brasil00416684224",
        "NO_DESCR_PT_BR": "abacaxi"
    },
    {
        "NU_CD": "@brasil00410054907",
        "NO_DESCR_PT_BR": "amora preta"
    },
    {
        "NU_CD": "@brasil00415842256",
        "NO_DESCR_PT_BR": "arroz e limão"
    },
    {
        "NU_CD": "@brasil00417309826",
        "NO_DESCR_PT_BR": "banana"
    }
]

Request   

GET api/form

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD   string   

O Código OBM do VTM

NO_DESCR_PT_BR   string   

O Nome do VTM

GET api/ingredient-source

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/ingredient-source?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_CD": "@brasil00514436858",
        "NO_DESCR_PT_BR": "DCB"
    }
]

Request   

GET api/ingredient-source

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD   string   

O Código OBM da Fontes dos Ingredientes

NO_DESCR_PT_BR   string   

O Nome da Fontes dos Ingredientes

GET api/substances

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/substances?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_ISID": "@brasil81510119965",
        "NO_NM_PT_BR": "Abacavir"
    },
    {
        "NU_ISID": "@brasil81975002137",
        "NO_NM_PT_BR": "Abatacepte"
    },
    {
        "NU_ISID": "@brasil81344650828",
        "NO_NM_PT_BR": "Abciximabe"
    }
]

Request   

GET api/substances

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_ISID,NO_NM_PT_BR

Must be one of:
  • NU_ISID
  • NO_NM_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_ISID   string   

O Código OBM do Ingredientes

NO_NM_PT_BR   string   

O Nome do Ingredientes

GET api/package

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/package?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_CD": "21",
        "NO_DESCR_PT_BR": "BISNAGA DE ALUMINIO"
    },
    {
        "NU_CD": "22",
        "NO_DESCR_PT_BR": "BISNAGA DE ALUMINIO PLASTICO TRANSPARENTE"
    },
    {
        "NU_CD": "23",
        "NO_DESCR_PT_BR": "BISNAGA DE ALUMINIO REVESTIDA"
    }
]

Request   

GET api/package

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD   string   

O Código OBM da Embalagem

NO_DESCR_PT_BR   string   

O Nome da Embalagem

GET api/atc-category

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/atc-category?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_CD": "A01AA01",
        "NO_DESCR_PT_BR": "fluoreto de sódio"
    },
    {
        "NU_CD": "A01AA02",
        "NO_DESCR_PT_BR": "monofluorfosfato de sódio"
    },
    {
        "NU_CD": "A01AA03",
        "NO_DESCR_PT_BR": "monofluorfosfato de sódio"
    }
]

Request   

GET api/atc-category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD   string   

O Código OBM da Categorias ATC

NO_DESCR_PT_BR   string   

O Nome da Categorias ATC

GET api/med-class

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/med-class?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[{
 "NU_CD":"0001"
 "NO_DESCR_PT_BR":"Referência"
},
{
 "NU_CD":"0003"
 "NO_DESCR_PT_BR":"Similar" 
},
{
 "NU_CD":"0008"
 "NO_DESCR_PT_BR":"Baixo Risco"
}]

Request   

GET api/med-class

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD      

O Código OBM das Categorias Regulatórias da ANVISA

NO_DESCR_PT_BR      

O Nome das Categorias Regulatórias da ANVISA

GET api/country

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/country?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_CD": "004",
        "NO_DESCR_PT_BR": "Afeganistão"
    },
    {
        "NU_CD": "710",
        "NO_DESCR_PT_BR": "África do Sul"
    },
    {
        "NU_CD": "008",
        "NO_DESCR_PT_BR": "Albânia"
    }
]

Request   

GET api/country

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD   string   

O Código OBM da Embalagem

NO_DESCR_PT_BR   string   

O Nome da Embalagem

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/legal-category?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_CD": "0001",
        "NO_DESCR_PT_BR": "Medicamentos sem tarja / Medicamentos isentos de prescrição (MIP)"
    },
    {
        "NU_CD": "0002",
        "NO_DESCR_PT_BR": "Medicamentos de tarja vermelha"
    },
    {
        "NU_CD": "0003",
        "NO_DESCR_PT_BR": "Medicamentos de tarja vermelha com retenção de receita"
    }
]

Response

Response Fields

NU_CD   string   

O Código OBM das Tarjas dos AMPPs

NO_DESCR_PT_BR   string   

O Nome das Tarjas dos AMPPs

GET api/control-drug-category

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/control-drug-category?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_CD": "0000",
        "NO_DESCR_PT_BR": "Sem Status de Controle Especial"
    },
    {
        "NU_CD": "00001",
        "NO_DESCR_PT_BR": "Lista A1 (Substâncias Entorpecentes)"
    },
    {
        "NU_CD": "0002",
        "NO_DESCR_PT_BR": "Lista A1 (Substâncias Entorpecentes) - ADENDO"
    }
]

Request   

GET api/control-drug-category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD   string   

O Código OBM das Categorias Controlados

NO_DESCR_PT_BR   string   

O Nome das Categorias Controlados

GET api/indicator

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/indicator?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[{
 "NU_CD":"@brasil00313553229"
 "NO_DESCR_PT_BR":"Discreto"
}]

Request   

GET api/indicator

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD      

O Código OBM dos Indicadores das Doses

NO_DESCR_PT_BR      

O Nome dos Indicadores das Doses

GET api/supplier

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/supplier?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_CD": "004",
        "NO_DESCR_PT_BR": "Afeganistão"
    },
    {
        "NU_CD": "710",
        "NO_DESCR_PT_BR": "África do Sul"
    },
    {
        "NU_CD": "008",
        "NO_DESCR_PT_BR": "Albânia"
    }
]

Request   

GET api/supplier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD   string   

O Código OBM da Embalagem

NO_DESCR_PT_BR   string   

O Nome da Embalagem

GET api/healthcare

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/healthcare?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/healthcare could not be found."
}

Request   

GET api/healthcare

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

GET api/local-application

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/local-application?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[{
 "NU_CD":"0",
 "NO_DESCR":"Sem registro no sistema de informação de origem"
},
{
 "NU_CD":"1",
 "NO_DESCR":"Deltóide Direito"
},
{
 "NU_CD":"2",
 "NO_DESCR":"Deltóide Esquerdo"
},

Request   

GET api/local-application

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR

Must be one of:
  • NU_CD
  • NO_DESCR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD      

O Código OBM do Local

NO_DESCR      

O Nome do Local

GET api/anvs-class

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/anvs-class?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_CD": "110070",
        "NO_DESCR_PT_BR": "Análogo sintético da vitamina D"
    },
    {
        "NU_CD": "603015",
        "NO_DESCR_PT_BR": "ACTH e similares"
    },
    {
        "NU_CD": "107034",
        "NO_DESCR_PT_BR": "Adsorventes e antisépticos  intestinais simples"
    }
]

Request   

GET api/anvs-class

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD   string   

O Código OBM da Categoria

NO_DESCR_PT_BR   string   

O Nome da Categoria

GET api/imunologico

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/imunologico?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[{
 "NU_CD":"1",
 "NO_DESCR":"Imunoglobulina humana antitétano"
},
{
 "NU_CD":"2",
 "NO_DESCR":Soro antitetânico"
},
{
 "NU_CD":"3",
 "NO_DESCR":"Soro antiaracnídico"
},

Request   

GET api/imunologico

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR

Must be one of:
  • NU_CD
  • NO_DESCR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD      

O Código OBM do VTM

NO_DESCR      

O Nome do VTM

GET api/route

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/route?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[{
 "NU_CD":"10862",
 "NO_DESCR_PT_BR":"otológica"
},
{
 "NU_CD":"10863",
 "NO_DESCR_PT_BR":"bucal"
},
{
 "NU_CD":"10864",
 "NO_DESCR_PT_BR":"dermatológica"
},

Request   

GET api/route

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD      

O Código OBM de Vias de Administração

NO_DESCR_PT_BR      

O Nome de Vias de Administração

GET api/rename

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/rename?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[{
 "NU_CD":"0001",
 "NO_DESCR_PT_BR":"Básico"
},
{
 "NU_CD":"0002",
 "NO_DESCR_PT_BR":"Especializado"
},
{
 "NU_CD":"0003",
 "NO_DESCR_PT_BR":"Estratégico"
},

Request   

GET api/rename

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD      

O Código OBM de Rename

NO_DESCR_PT_BR      

O

GET api/availability-restriction

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/availability-restriction?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[{
 "NU_CD":"0001",
 "NO_DESCR_PT_BR":"Comercialização conforme indicação do Ministério da Saúde"
},
{
 "NU_CD":"0002",
 "NO_DESCR_PT_BR":"Uso hospitalar"
},
{
 "NU_CD":"0003",
 "NO_DESCR_PT_BR":"Uso institucional"
}

Request   

GET api/availability-restriction

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD      

O Código OBM de Restrições de uso ou venda

NO_DESCR_PT_BR      

O Nome de Restrições de uso ou venda

GET api/basis-of-strnth

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/basis-of-strnth?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[{
 "NU_CD":"@brasil00214196736",
 "NO_DESCR_PT_BR":"Baseada no princípio ativo"
},
{
 "NU_CD":"@brasil00216659284",
 "NO_DESCR_PT_BR":"Baseada no princípio ativo em sua forma básica"
},
{
 "NU_CD":"@brasil00210706216",
 "NO_DESCR_PT_BR":"Desconhecido"
}

Request   

GET api/basis-of-strnth

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD      

O Código OBM de Referências das Concentrações

NO_DESCR_PT_BR      

O Nome de Referências das Concentrações

GET api/catmat

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/catmat?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_CATMAT": "BR0267713",
        "DS_CATMAT": "Descrição do Catálogo de Materiais"
    },
    {
        "NU_CATMAT": "BR0268423",
        "DS_CATMAT": "Descrição do Catálogo de Materiais"
    },
    {
        "NU_CATMAT": "BR0268423",
        "DS_CATMAT": "Descrição do Catálogo de Materiais"
    }
]

Request   

GET api/catmat

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CATMAT,DS_CATMAT

Must be one of:
  • NU_CATMAT
  • DS_CATMAT
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CATMAT   string   

O Código do Catálogo de Materiais

DS_CATMAT   string   

Descrição do Catálogo de Materiais

GET api/name-change

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/name-change?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[{
 "NU_CD":"@brasil00618609757",
 "NO_DESCR_PT_BR":"Substituição de um nome temporário"
},
{
 "NU_CD":"@brasil00610126376",
 "NO_DESCR_PT_BR":"Novo nome genérico aprovado"
},
{
 "NU_CD":"@brasil00614802609",
 "NO_DESCR_PT_BR":"Nome alterado"
}

Request   

GET api/name-change

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD      

O Código OBM de Motivos de Alteração do Nome

NO_DESCR_PT_BR      

O Nome de Motivos de Alteração do Nome

GET api/discontinued-ind

requires authentication

Example request:
curl --request GET \
    --get "http://portalobm.local/api/discontinued-ind?api_token=%7BYOUR_AUTH_KEY%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "NU_CD": "001",
        "NO_DESCR_PT_BR": "Descrição Indicador Descontinuidade Portugues"
    }
]

Request   

GET api/discontinued-ind

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fields   string  optional  

CSV com o(s) atributos a serem exibidos. Example: NU_CD,NO_DESCR_PT_BR

Must be one of:
  • NU_CD
  • NO_DESCR_PT_BR
where   string  optional  

JSON com o(s) filtros a serem utilizados. Example: {"START_CHANGE_DATETIME":"2024-05-13"}

Must be one of:
  • START_CHANGE_DATETIME
  • END_CHANGE_DATETIME

Query Parameters

api_token   string   

Authentication key. Example: {YOUR_AUTH_KEY}

Response

Response Fields

NU_CD   string   

O Código OBM de Indicadores de Descontinuidades

NO_DESCR_PT_BR   string   

O Nome de Indicadores de Descontinuidades