Web Service Integration for OEM & Enterprise

Disponível para:
The Web Service Integration allows administrators to connect CountThings from Photos to internal company systems through custom web service calls.
Admins can configure all connections from our Portal, assign them to users, and automate how data is imported or exported between the app and the company's IT systems.
In this example, we'll simulate an API call using our test environment to show how an admin can configure a web service integration and assign it to users, and how operators can use it within the app.
Configure the Web Service Call
First, we will set up the sample web service call to simulate how data can be imported into the app. You can also make this simulation by following the steps below:
1. Open https://countthings.com/en/log in to your Account ➜ click Log In
2. Open https://countthings.com/testformsync ➜ Confirm you are still logged in to your account ➜ click on Add Field
3. Add your Field details
A. DescriptionWrite a description of your field (e.g. Material)
B. ValueWrite the value you want to automatically add to the app (e.g. Steel)
4. Repeat the process to add another field.
A. Click on Add Field
B. Description ➜ Write a description of your field (e.g. Size and Length)
C. Value ➜ Write the value you want to automatically add to the app (e.g. 0.15x 2m, 0.2 x 3m, 0.2 x 4m) In this example we added more values to be added by the call.
5. Click Save ➜ A confirmation pop up should appear ➜ Click OK
Form Settings
Create a Form in the Portal that will receive and display data coming from your company's web service call. The fields must have the same names as those returned in the API response. (e.g. Material and Size and Length)
Admins can later assign this Form to specific operators, who can use it when they start a new counting session.
1. From the upper bar of the screen, click on my account
2. Go to Forms section ➜ choose for which account you want to create this form (e.g. enterprise@test.com) ➜ click +NEW FORM to start creating a new one.
3. Create From Window will appear:
A. Write the name of your Form (e.g. Call Test)
B. Select the platform on which your Form will be available (e.g. iOS/Android)
C. Click Confirm
4. Form Settings:
A. You can see and edit the name of your Form (e.g. Call Test)
B. Configure the setting for your Form
C. Click +Add field to start adding your Form fields
5. Choose the type of field you want to add in your form and click Done (e.g. we choose Text Box to fit the details we want to receive through the API Call)
6. In Text Box settings, add the name of your Field.
After you have set up your field, click +Add field to add another Form Field. (e.g. we named the field Material to match the first field of the API Call)
7. Choose the type of field you want to add in your form ➜ click Done (e.g. we choose Dropdown to fit the details we want to receive through the API Call)
8. In Dropdown settings, add the name of your Field (e.g. we named it Size and Length to match the second field of the API Call)
9. Scroll up and from the upper right side of the screen click Save
10. After a few seconds, you should be able to see the Form you've created. Click on the Actions icon and click Users (Operators).
11. The "Associate users (operators) for form Call Test" pop-up will appear.
Check the box
next to the user you want to assign the Form to ➜ Click the ">" button to associate the user ➜ click Close after your user is associated and moved in the right side of the pop-up. (e.g. we choose user1@test.com)
You can always return and assign a form to multiple operators or remove them.
Create the Web Service Integration in Portal
Once your Form is ready, set up the web service integration that defines how data will be sent or received between CountThings and your company's system.
1. Go to Integrations section ➜ choose for which account you want to create this Webservice ➜ click +New Webservice
2. Web service settings:
A. Write the name for your web service (e.g. WebService Integration Call Test)
B. Choose the Protocol and insert the address you want to send or receive data from (e.g. https://countthings.com/getformsync)
C. Choose the Authentication Type (e.g. None)
D. Use the Choose when to send dropdown to select your preference (e.g. Manually (show button in form)) ➜ Give your Form Button a name (e.g. Get Call Test)
3. Scroll down to review and configure any additional settings if needed.
4. Scroll up and from the right side of the screen click Save
5. After a few seconds, you should be able to see the web service you've created.
Click on the Operators icon and associate the operators with this webservice. Confirm that you are still operating the Web Services for the desired account. (e.g. enterprise@test.com)
6. Check the box next to the user you want to assign the Web Service Call to ➜ Click the ">" button to associate the user ➜ click Close after your user is associated and moved in the right side of the pop-up. (e.g. we choose user1@test.com)
Usage
Once the admin setup is complete, operators can use the configured Form and Web Service integration directly in the CountThings app. (e.g. in this step user1@test.com should sign in and use the configuration)
1. From Home Screen:
A. Make sure your operator has the right Counting Template set as active.
B. Open the photo to be counted
2. In Prepare Screen Go to Forms
3. In Fill out Forms screen Tap GET CALL TEST (e.g. This is the button we named in the previous section)
4. Your Form Fields will be automatically updated with the data from the web service call.
5. You can choose the value from the dropdown automatically completed in Form for Size and Length.
6. Tap Back to return to Prepare screen Tap COUNT
7. SAVE the results