# Clientes e Moradas Neste primeiro exemplo, ao realizar um pedido para a rota irá receber uma resposta semelhante à descrita de seguida, com uma lista de elementos 'data', onde cada elemento corresponde a um cliente associado à sua empresa. Esta rota não requer qualquer tipo de parâmetros. À semelhança do pedido anterior, se este for realizado para a rota ``` https://apiv1.toconline.com/customers/{id} ``` Irá obter como resposta apenas as informações de um único cliente, em vez de receber uma lista de todos os clientes existentes. {% openapi src="/files/Ph0j7Hyh5VB7NivP1zhf" path="/customers/{id}" method="get" %} [openapi\_swagger.yml](https://1113994710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiTdJalKSEf3HO0XWftdu%2Fuploads%2FVKja7VTBGEn3Y3110UWU%2Fopenapi_swagger.yml?alt=media\&token=9ecc7973-2b20-491a-b2ee-e9de90da70ed) {% endopenapi %} A seguinte rota permite a criação de novas instâncias de clientes, associados à sua empresa. De modo a realizar um pedido para esta rota, terá de enviar alguns parâmetros no body do pedido.\ Tal como está descrito no pedido em baixo, dentro do body terá de criar dois objetos: data, e relationships. \ Dentro de data, deverá colocar todos os parâmetros obrigatórios (assinalados com um asterisco), e poderá também colocar os restantes parâmetros, se for do seu interesse. O tipo dos parâmetros está também especificado. \ Dentro de relationships deverá colocar um objeto para cada uma das entradas descritas em baixo, sendo que cada uma deverá conter todos os parâmetros indicados. {% openapi src="/files/Ph0j7Hyh5VB7NivP1zhf" path="/customers" method="post" %} [openapi\_swagger.yml](https://1113994710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiTdJalKSEf3HO0XWftdu%2Fuploads%2FVKja7VTBGEn3Y3110UWU%2Fopenapi_swagger.yml?alt=media\&token=9ecc7973-2b20-491a-b2ee-e9de90da70ed) {% endopenapi %} A seguinte rota permite a remoção de um dado cliente. Esta rota deve ser utilizada de forma cautelosa dado que é irreversível, e mesmo que este cliente volte a ser criado, o seu id nunca será o mesmo que teria anteriormente. \ Utilizando o id do cliente que quer eliminar, que poderá fazer utilizando a primeira rota desta página, por exemplo, terá simplesmente de fazer um pedido para . Este irá retornar OK em caso de sucesso. {% openapi src="/files/Ph0j7Hyh5VB7NivP1zhf" path="/customers/{id}" method="delete" %} [openapi\_swagger.yml](https://1113994710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiTdJalKSEf3HO0XWftdu%2Fuploads%2FVKja7VTBGEn3Y3110UWU%2Fopenapi_swagger.yml?alt=media\&token=9ecc7973-2b20-491a-b2ee-e9de90da70ed) {% endopenapi %} A rota PATCH permite a edição de um cliente existente. O body deste pedido deverá ser igual ao descrito na rota POST, contendo todas as informações obrigatórias do cliente, atualizadas para os valores que tenciona alterar, além do campo "id" no "data" do "body". Álem disto, o pedido deverá ser feito a , sendo que {id} é o identificador do cliente que tenciona atualizar. {% openapi src="/files/Ph0j7Hyh5VB7NivP1zhf" path="/customers/{id}" method="patch" %} [openapi\_swagger.yml](https://1113994710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiTdJalKSEf3HO0XWftdu%2Fuploads%2FVKja7VTBGEn3Y3110UWU%2Fopenapi_swagger.yml?alt=media\&token=9ecc7973-2b20-491a-b2ee-e9de90da70ed) {% endopenapi %} ### Morada De modo a associar uma morada a um cliente, deverá realizar o seguinte pedido {% openapi src="/files/Ph0j7Hyh5VB7NivP1zhf" path="/addresses" method="post" %} [openapi\_swagger.yml](https://1113994710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiTdJalKSEf3HO0XWftdu%2Fuploads%2FVKja7VTBGEn3Y3110UWU%2Fopenapi_swagger.yml?alt=media\&token=9ecc7973-2b20-491a-b2ee-e9de90da70ed) {% endopenapi %} ``` curl -v -X PATCH -H 'Content-Type: application/vnd.api+json' -H 'Accept: application/json' -H 'Authorization: Bearer ' -d '' '/addresses' ``` No pedido acima, o \ corresponde ao token de acesso válido devolvido pelo serviço de OAuth, e o \ deverá ter o seguinte formato ``` // Exemplo de payload { "data": { "type": "addresses", // [OBRIGATÓRIO] "id": "", // [OBRIGATÓRIO] "attributes": { "address_detail": "Test address", // [OPCIONAL] "city": "Test city", // [OPCIONAL] "postcode": "0000-000", // [OPCIONAL] Se o país for Portugal, deve obedecer ao formato português, DDDD-DDD "region": "Test region" // [OPCIONAL] }, "relationships": { // [OPCIONAL] Recursos associados à morada. Caso nenhum seja indicado, este bloco "relationships" deve ser omitido "country": { // [OPCIONAL] Por omissão, a morada fica associada ao país "PT" "data": { "type": "countries", // [OBRIGATÓRIO] "id": "" // [OBRIGATÓRIO] Vd. NOTA 1 } } } } } ``` NOTA 1: O "id" interno do país deve ser obtido por um GET /countries?filter\[iso\_alpha\_2]=PT|\... São também suportados dois "países" adicionais: "PT-AC" (Portugal, Açores) e "PT-MA" (Portugal, Madeira). ### E-mail De modo a associar um email a um cliente, deverá realizar o seguinte pedido {% openapi src="/files/Ph0j7Hyh5VB7NivP1zhf" path="/email\_addresses" method="get" %} [openapi\_swagger.yml](https://1113994710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiTdJalKSEf3HO0XWftdu%2Fuploads%2FVKja7VTBGEn3Y3110UWU%2Fopenapi_swagger.yml?alt=media\&token=9ecc7973-2b20-491a-b2ee-e9de90da70ed) {% endopenapi %} ``` curl -v -X PATCH -H 'Content-Type: application/vnd.api+json' -H 'Accept: application/json' -H 'Authorization: Bearer ' -d '' '/email_addresses' ``` No pedido acima, o \ corresponde ao token de acesso válido devolvido pelo serviço de OAuth, e o \ deverá ter o seguinte formato ``` { "data": { "type": "email_addresses", // [OBRIGATÓRIO] "id": "", // [OBRIGATÓRIO] "attributes": { "email": "test@gmail.com", // [OBRIGATÓRIO] } } } ``` ### --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://cloudware.gitbook.io/documentacao-api/api-v0/clientes-e-moradas.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.