Difference between revisions of "Connecting to the API"
(→NEW Java 1.8 API) |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | The WebAPI toolkit is located on | + | The WebAPI toolkit is located on a separate server to the live MyMobileWorkers server. The url is |
| − | HTTPS : [https:// | + | HTTPS : [https://api.mymobileworkers.com:8181/api/1/ https://api.mymobileworkers.com:8181/api/1/] |
| − | '''Avoid using this insecure http option where possible''' - HTTP : [http:// | + | '''Avoid using this insecure http option where possible''' - HTTP : [http://api.mymobileworkers.com:8080/api/1/ http://api.mymobileworkers.com:8080/api/1/] |
| − | Each version of the API will have a new URL to prevent causing problems with existing solutions. For further information please see the versioning | + | Each version of the API will have a new URL to prevent causing problems with existing solutions. For further information please see the versioning. |
| + | |||
| + | == NEW Java 1.8 API == | ||
| + | |||
| + | We now have a new more secure API server which uses Java 1.8, its new endpoint is - | ||
| + | HTTPS : [https://api.mymobileworkers.com:8181/api/1/ https://api20.mymobileworkers.com/] | ||
| + | |||
| + | There are slight differences in the create job call that will need to be factored in if using the new Java 1.8 api (this can be found in the create job call documentation). | ||
| + | |||
| + | == Certificate Authority (CA) Error == | ||
| + | |||
| + | The API server's certificate for HTTPS requires the AlphaSSL Intermediate CA from 2014 and the GlobalSign Root CA. These are likely to be in your server's existing CA certificates file, but if they are not you may get an error when making a call to our API, such as: | ||
| + | |||
| + | "SSL certificate problem, verify that the CA cert is OK. Details: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed" | ||
| + | |||
| + | If this occurs then you may need to update your CA certificates file. | ||
| + | |||
| + | A good source of an up-to-date CA certificates file is: | ||
| + | https://curl.haxx.se/docs/caextract.html | ||
| + | |||
| + | If you wish to add only the files to an existing certificate file, you can get that from: | ||
| + | https://www.alphassl.com/support/install-root-certificate.html | ||
| + | |||
| + | Consult your software's documentation for details on how to ensure the new CA cert file is used when making a connection. | ||
== Development == | == Development == | ||
| − | For the | + | For the purposes of development MyMobileWorkers can provide test environments to aid testing before going live. For further information please contact support. |
Latest revision as of 14:42, 1 October 2020
The WebAPI toolkit is located on a separate server to the live MyMobileWorkers server. The url is
HTTPS : https://api.mymobileworkers.com:8181/api/1/
Avoid using this insecure http option where possible - HTTP : http://api.mymobileworkers.com:8080/api/1/
Each version of the API will have a new URL to prevent causing problems with existing solutions. For further information please see the versioning.
[edit] NEW Java 1.8 API
We now have a new more secure API server which uses Java 1.8, its new endpoint is - HTTPS : https://api20.mymobileworkers.com/
There are slight differences in the create job call that will need to be factored in if using the new Java 1.8 api (this can be found in the create job call documentation).
[edit] Certificate Authority (CA) Error
The API server's certificate for HTTPS requires the AlphaSSL Intermediate CA from 2014 and the GlobalSign Root CA. These are likely to be in your server's existing CA certificates file, but if they are not you may get an error when making a call to our API, such as:
"SSL certificate problem, verify that the CA cert is OK. Details: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed"
If this occurs then you may need to update your CA certificates file.
A good source of an up-to-date CA certificates file is: https://curl.haxx.se/docs/caextract.html
If you wish to add only the files to an existing certificate file, you can get that from: https://www.alphassl.com/support/install-root-certificate.html
Consult your software's documentation for details on how to ensure the new CA cert file is used when making a connection.
[edit] Development
For the purposes of development MyMobileWorkers can provide test environments to aid testing before going live. For further information please contact support.
