Work Order Integration Protocol Documentation

Introduction

We have developed a communication protocol to create, edit, delete, consult and list work orders, it has been implemented through a rest api. The body of the message for the endpoints is a json type text described in the format section of this document.

First Steps

In order to access the WorkOrders consumer service, you must first log in.

Test url:

1 https://simaapi-test.ddns.net

How to get the user API-KEY (login)?

You must use the next endpoint to obtain the access_token.

Login uri:

1 /login/{user}/{password}

Method:

1 GET

Header:

1 2 'Accept: application/json', 'Content-Type: application/json'

Response example:

1 2 3 4 5 6 7 { "access_token": "111", "refresh_token": "034d7e33-5e5c-4ac9-9caf-746af2d0df14", "expiration_datetime": "2017-02-14T16:30:44-0300", "minimum_app_version": 130, "latest_app_version": 234 }

If we get an Http 200 response, we recommend saving the access_token obtained for future inquiries.

Necessary enpoints to integrate as a third party

Work order endpoints

https://sima.atlassian.net/wiki/spaces/STD/pages/2106032164

Format

https://sima.atlassian.net/wiki/spaces/STD/pages/2105311275

Description of protocol attributes

https://sima.atlassian.net/wiki/spaces/STD/pages/2106261521

Class diagram

Link to class diagram: https://drive.google.com/file/d/1UfsRqjM7wborKcKFlnAaCgVVkrbdwXyb/view?usp=sharing