Saltar para o conteúdo
API DA WEEZIE

Tudo o que pode fazer na Weezie, disponível através da API.

A Weezie foi criada para ser utilizada tanto através da interface como de forma programática. As ações disponíveis aos utilizadores na interface da Weezie também podem ser executadas através da API, dando à sua equipa flexibilidade para integrar os dados da rede e os fluxos operacionais diretamente nos seus próprios sistemas.

Example API request
GET /api/v1/assets
Authorization: Bearer {token}
Accept: application/json

UTILIZE A API À SUA MANEIRA

Utilize a Weezie como plataforma, não apenas como aplicação.

A API expõe as mesmas capacidades da plataforma utilizadas pela interface da Weezie. Desta forma, pode ligar a Weezie a aplicações internas, automatizar operações repetitivas, sincronizar dados ou criar experiências completamente diferentes sobre a plataforma.

Dados de rede

Consulte e gira a informação de rede de que os seus fluxos de trabalho dependem, incluindo os ativos e as relações representados na Weezie.

Planeamento e projeto

Integre as operações de planeamento e projeto de rede em ferramentas externas e fluxos de trabalho automatizados.

Operações no terreno

Ligue os fluxos de trabalho no terreno aos restantes sistemas utilizados pela sua organização.

Tarefas e fluxos de trabalho

Utilize a API para ligar as operações da Weezie aos seus processos de negócio existentes.

Inventário e conetividade

Trabalhe de forma programática com o inventário da rede e as respetivas relações.

Ficheiros e informação de suporte

Mantenha a informação operacional associada aos correspondentes registos de rede ou de fluxo de trabalho.

Relatórios e acesso a dados

Utilize os dados da Weezie fora da aplicação quando outro sistema precisar de os consumir, transformar ou apresentar.

Aplicações personalizadas

Crie experiências em torno da Weezie sem ter de reproduzir a plataforma de rede subjacente.

UMA PLATAFORMA, VÁRIAS FORMAS DE TRABALHAR

Utilize a interface, a API ou ambas.

As suas equipas não têm de escolher entre fluxos de trabalho manuais e integrações. As operações podem ser realizadas através da interface da Weezie quando a interação direta fizer sentido, enquanto a mesma plataforma pode ser acedida de forma programática quando a automação ou a comunicação entre sistemas for mais adequada.

01

Pessoas e sistemas podem trabalhar sobre os mesmos dados

Os utilizadores podem trabalhar através da interface enquanto as integrações interagem com a plataforma subjacente através da API.

02

Desenvolva em torno da sua arquitetura existente

Utilize a API para ligar a Weezie aos sistemas que já participam nas operações da sua rede.

03

Automatize onde fizer sentido

Os processos que, de outro modo, exigiriam interação com a interface podem ser incorporados em fluxos de trabalho automatizados.

04

Criar experiências especializadas

Utilize as capacidades da plataforma que suportam a Weezie para criar aplicações e interfaces destinadas a uma equipa, cliente ou processo específico.

PEDIDOS E RESPOSTAS

Trabalhe com a Weezie de forma programática.

As operações da API seguem os mesmos conceitos de domínio representados em toda a Weezie, facilitando a transição entre fluxos interativos e programáticos.

Exemplos de código para a API da Weezie

Exemplo de pedido

GET /api/v1/assets
Authorization: Bearer {token}
Accept: application/json

Exemplo de resposta

GET /api/v1/network/assets/{id}
Accept: application/json
Authorization: Bearer {token}

Exemplo de corpo da resposta

{
  "id": "...",
  "type": "...",
  "properties": {
    "...": "..."
  }
}

*Os exemplos apresentados nesta página são meramente ilustrativos. Os recursos, campos e operações disponíveis dependem das capacidades correspondentes da Weezie e da documentação da API.*

CONSIDERAÇÕES SOBRE A INTEGRAÇÃO

Tudo o que é necessário para projetar uma integração fiável.

Lista de verificação para o projeto da implementação

Dos pressupostos de projeto à fiabilidade operacional.

Utilize esta lista de verificação como primeira análise antes de planear a implementação.

Autenticação e acesso

Como as aplicações se autenticam e a que recursos da Weezie têm autorização para aceder.

Modelo de dados

Como os conceitos de rede, inventário, planeamento e operação da Weezie correspondem aos seus próprios sistemas.

Erros e validação

Como as integrações devem tratar pedidos inválidos, resultados de validação e operações sem êxito.

Paginação e consultas

Como as aplicações podem trabalhar de forma eficiente com coleções e conjuntos de dados maiores, quando aplicável.

Versionamento

Como as integrações podem ter em conta alterações aos recursos e ao comportamento da API ao longo do tempo.

Operações repetíveis

Como os processos automatizados podem coordenar ações entre sistemas de forma segura.

Eventos e automação

Quando adequado, o projeto de uma integração pode combinar operações da API com eventos ou automação externa.

Padrões de utilização

Podemos analisar a utilização prevista da API como parte do projeto da integração.

Desenvolvimento e testes

As abordagens de integração podem ser validadas antes de serem introduzidas nos fluxos de produção.

Gestão do ciclo de vida e das alterações

As dependências das integrações podem ser consideradas à medida que a Weezie e os sistemas ligados evoluem.

Documentação

Os endpoints, recursos, parâmetros e comportamentos de integração relevantes podem ser documentados para a implementação.

CRIADA EM TORNO DO SEU FLUXO DE TRABALHO

Comece pelo que pretende ligar.

Uma integração não tem de começar por uma lista de endpoints. Comece pelo fluxo de trabalho, pelos sistemas envolvidos e pelo resultado que pretende alcançar. A partir daí, podemos identificar como a API da Weezie se enquadra na arquitetura.

Integrações OSS e BSS

Crie fluxos estáveis de encomendas e serviços, preservando as correspondências de faturação e ativos.

Sistemas SIG e geoespaciais

Troque estruturas, geometrias e contexto com a sua camada operacional espacial.

Plataformas ERP e de inventário

Coordene materiais, ativos e capacidade da rede com os registos de planeamento operacional.

Ferramentas de planeamento de redes

Integre as decisões de planeamento no mesmo sistema de referência, com um fluxo claro de aceitação e entrega.

Aplicações de campo

Encaminhe as conclusões do terreno e o tratamento de exceções para o mesmo limite de integração.

Relatórios e análise

Prepare informação de rede e operacional para sistemas de análise internos ou externos.

Sincronização de dados

Sincronize registos quando os sistemas têm diferentes expectativas de atualização ou responsabilidade.

Automação de fluxos de trabalho

Transfira ações operacionais repetitivas para fluxos de trabalho duradouros e testáveis.

Aplicações internas

Crie ferramentas operacionais diferenciadas para equipas distintas sobre uma infraestrutura de rede partilhada.

Portais de clientes ou parceiros

Disponibilize capacidades e atualizações de estado selecionadas sem perder o controlo dos identificadores principais.

CRIAR UMA INTEGRAÇÃO FUNCIONAL

Ligue a Weezie ao resto da sua operação.

Quer precise de automatizar um fluxo de trabalho existente na Weezie, sincronizar dados de rede com outra plataforma ou criar uma aplicação personalizada, a API oferece uma forma programática de trabalhar com as mesmas capacidades disponíveis na Weezie.