# Ordem de escolta de gaiola ![](https://docs.equinix.com/pt-BR/assets/images/OrderCageEscort-03d9712dd9f2ca9087dc6e55dfd1714d.png) ## Pré-requisitos[​](#pré-requisitos "Link direto para Pré-requisitos") 1. Autenticar - Envie suas credenciais de usuário, ID do cliente e segredo do cliente para autenticação OAuth2. Consulte [Autenticação API](https://docs.equinix.com/pt-BR/equinix-api/api-authentication.md) para obter instruções sobre como chamar o OAuth API para validar e autenticar suas credenciais. 2. Obter um número de pedido de visita de trabalho - Envie uma `GET` solicitação ao [`/colocations/v2/orders/{orderId}`](https://docs.equinix.com/pt-BR/api-catalog/ordersv2/orders/get%20order%20details.md) terminal para recuperar um número de pedido para uma visita de trabalho que já foi agendada. Para agendar uma nova visita de trabalho, envie uma `POST` solicitação para o [`colocations/v2/orders/workVisits`](https://docs.equinix.com/pt-BR/api-catalog/workvisitsv2/work-visit/schedule%20work%20visit%20services.md) terminal. Você deve ter `IBX Access Services` permissão para agendar uma visita de trabalho. Você pode ignorar esta etapa se já tiver o número do pedido de visita de trabalho. 3. Para obter detalhes do Smart Hands, o usuário deve ter `Smart Hands`permissões de pedido. 4. Get Smart Hands Types - Envie uma `GET` solicitação para o [`/v1/orders/smarthands/types`](https://docs.equinix.com/pt-BR/api-catalog/smarthandsv1/smarthands/smarthandtypes.md) terminal para obter todos os tipos de pedidos Smart Hands. Você pode ignorar esta etapa se já souber o tipo de pedido Smart Hands. 5. Obter informações de localização - Envie uma `GET` solicitação ao [`/v1/orders/smarthands/locations`](https://docs.equinix.com/pt-BR/api-catalog/smarthandsv1/smarthands/getlocation.md) terminal para recuperar os locais IBX disponíveis aos quais você tem acesso. Você pode pular esta etapa se já souber as informações de localização. ## Pedido uma acompanhante em Cage - exemplo mínimo[​](#pedido-uma-acompanhante-em-cage---exemplo-mínimo "Link direto para Pedido uma acompanhante em Cage - exemplo mínimo") Para solicitar uma escolta de segurança IBX para um visitante acessar seu cage, envie uma `POST` solicitação para o [`/smarthands/cageEscort`](https://docs.equinix.com/pt-BR/api-catalog/smarthandsv1/smarthands.md) terminal. Exemplo de solicitação cURL: ``` curl -X POST "https://api.equinix.com/v1/orders/smarthands/cageEscort" -H "content-type: application/json" -H "authorization: Bearer " -d '{     "ibxLocation": {     "ibx": "AM1",     "cages": [         {         "cage": "AM1:0J:00JD11",         "accountNumber": "126854"         }     ]     },     "serviceDetails": {     "workVisitOrderNumber": "1-19864326570532",     "openCabinetForVisitor": true,     "supervisionReqForVisitor": true,     "durationVisit": "4 Hours",     "scopeOfWork": "If staff from customer company is unable to attend, please continue to accompany the visitor."     },     "schedule": {     "scheduleType": "SCHEDULED_MAINTENANCE",     "requestedStartDate": "2019-08-30T22:00:49.776Z",     "requestedCompletionDate": "2019-08-31T22:00:49.776Z"     },     "contacts": [     {         "contactType": "ORDERING",         "userName": "johndoe"     },     {         "contactType": "TECHNICAL",         "userName": "johndoe",         "workPhonePrefToCall": "ANYTIME"     },     {         "contactType": "NOTIFICATION",         "userName": "johndoe"     }     ] }' ``` Exemplo de resposta: ``` {     "OrderNumber": "1-19876653568916" } ``` A resposta indica que o pedido foi bem-sucedido e retorna o número do pedido. ## Pedido uma escolta em Cage - exemplo estendido[​](#pedido-uma-escolta-em-cage---exemplo-estendido "Link direto para Pedido uma escolta em Cage - exemplo estendido") Exemplo de solicitação cURL: Para solicitar uma escolta de segurança IBX para um visitante acessar seu cage, envie uma `POST` solicitação para o [`/smarthands/cageEscort`](https://docs.equinix.com/pt-BR/api-catalog/smarthandsv1/smarthands.md) terminal. Forneça os detalhes do serviço no corpo da solicitação. Use o `attachments` objeto para incluir detalhes adicionais para um técnico. > **Observação** > > Antes de criar um pedido com anexo, ligue para o [`Attachments File`](https://docs.equinix.com/pt-BR/api-catalog/attachmentsv1/attachments/createattachment.md) terminal. ``` curl -X POST "https://api.equinix.com/v1/orders/smarthands/cageEscort" -H "content-type: application/json" -H "authorization: Bearer " -d '{     "ibxLocation": {     "ibx": "AM1",     "cages": [         {             "cage": "AM1:0J:00JD11",             "cabinets": [                 "AM1:0J:00JD11:0001"             ],             "accountNumber": "126854"         }       ]     },     "serviceDetails": {         "workVisitOrderNumber": "1-19864326570532",         "openCabinetForVisitor": true,         "supervisionReqForVisitor": true,         "durationVisit": "4 Hours",         "scopeOfWork": "If staff from customer company is unable to attend, please continue to accompany the visitor.",         "needSupportFromASubmarineCableStationEngineer": true     },     "attachments": [      {         "id": "fcb2k8763-2947-456e-8d68-f280753d60ba",         "name": "WorkVisitInstructions.docx"      }   ],   "schedule": {     "scheduleType": "SCHEDULED_MAINTENANCE",     "requestedStartDate": "2019-08-30T22:00:49.776Z",     "requestedCompletionDate": "2019-08-31T22:00:49.776Z"   },     "customerReferenceNumber": "EQX-PO2019-08-001",     "purchaseOrder": {         "purchaseOrderType": "EXEMPTED",         "attachment": {             "id": "abc1fd2e-345f-67g4-hi89-01jk234l5m6n",             "name": "PurchaseOrderExemptionForm123.docx"     }   },   "contacts": [     {         "contactType": "ORDERING",         "userName": "johndoe"     },     {         "contactType": "TECHNICAL",         "name": "Jane Smith",         "email": "janesmith@corporation.com",         "workPhoneCountryCode": "+44",         "workPhone": "0148211111",         "workPhonePrefToCall": "MY_BUSINESS_HOURS",         "workPhoneTimeZone": "Europe/London",         "mobilePhoneCountryCode": "+44",         "mobilePhone": "0123456789",         "mobilePhonePrefToCall": "MY_BUSINESS_HOURS",         "mobilePhoneTimeZone": "Europe/London"     },     {         "contactType": "NOTIFICATION",         "userName": "johndoe"     },     {         "contactType": "NOTIFICATION",         "userName": "jillsnow"     }   ] }' ``` Para obter uma lista completa dos parâmetros e descrições do corpo, consulte [a Referência do API](https://docs.equinix.com/pt-BR/api-catalog/smarthandsv1/smarthands.md) .