Tipos de dados de parâmetros de solicitação
João M Nguimbi
Last Update há 4 anos
Embora todos os parâmetros sejam enviados como strings por HTTP, especificamos os tipos de parâmetros usados nas solicitações da API HTTP para ajudá-lo a identificar os valores que podem ser aprovados.
Booleano: os valores possíveis são verdadeiros ou falsos.
Inteiro: Os valores possíveis são números inteiros positivos.
Float: os valores possíveis são números positivos com um componente decimal.
String: Os valores possíveis são uma sequência de caracteres dependentes do contexto.
Array: os valores possíveis são qualquer coleção de valores dependentes do contexto do mesmo tipo. Arrays são especificados atribuindo diferentes valores do mesmo tipo ao mesmo nome de parâmetro várias vezes. (A ordem em que os valores são atribuídos não importa.)
Mapa: Os valores possíveis são qualquer coleção de pares nome-valor onde o nome é de tipo seqüência e o valor pode ser qualquer tipo dependente do contexto. Os pares Nome-valor são associados um ao outro, adicionando-lhes o mesmo sufixo numérico. O sufixo numérico, começa a partir de 1 e é incrementado para cada par subseqüente nome-valor.
Exemplo:? Domain-name1 = abc.com & nameserver1 = abc.example.com & domain-name2 = xyz.com & nameserver2 = xyz.example.com
Este associado abc.example.com com abc.com e xyz.example.com com xyz.com
Nota
Os valores dos parâmetros nas chamadas da API são sensíveis a maiúsculas e minúsculas e devem ser aprovados corretamente para obter detalhes completos na resposta.
Por exemplo, a chamada de API para buscar os detalhes de uma Ordem de Registro de Domínio tem opções de paramater. Os valores podem ser: Todos, OrderDetails, ContactIds, RegistrantContactDetails, AdminContactDetails, TechContactDetails, BillingContactDetails, NsDetails, DomainStatus, DNSSECDetails.
Esses valores são sensíveis a maiúsculas e minúsculas e precisam passar da maneira exata como mencionado acima.
Para associar detalhes extras a um contato particular ou a um nome de domínio, os detalhes devem ser passados na chamada API na forma de attr-name e attr-value pairs. Esses pares nome-valor devem ser passados sequencialmente, como attr-name1 = param & attr-value1 = value & attr-name2 = param & attr-value2 = value. Uso como attr-name1 = param & attr-value1 = value & attr-name3 = param & attr-value3 = valor está incorreto.
Exemplo:
Chamada de API correta
https://test.httpapi.com/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&company=company&[email protected]&address-line-1=address1&city=city&country=nn&zipcode=0&phone- cc = 0 & phone = 0 & customer-id = 0 & type = Contato & attr-name1 = title & attr-value1 = {Título do contato na empresa} & attr-name2 = website & attr-value2 = {Website da empresa}
Chamada de API incorreta
https://test.httpapi.com/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&company=company&[email protected]&address-line-1=address1&city=city&country=nn&zipcode=0&phone- cc = 0 & phone = 0 & customer-id = 0 & type = Contato & attr-name1 = title & attr-value1 = {Título do contato na empresa} & attr-name3 = website & attr-value3 = {Website da empresa}