AppMachine provides really powerful integration with your existing data via web services. Using the web service integration you can easily integrate your existing data into your app. But it will also allow you to post or edit your existing data from within the app. In this document you will find all kinds of FAQ about this topic.
FAQ
Q: What do I need if I want to start working with a webservice?
- The URL of your web service, e.g. http://www.arminvanbuuren.com/feed/json/
- The goal of your web service, so will it be used to retrieve, create, update or delete data?
- Are there any parameters that should be specified when i want to use my web service?
- A little bit of technical knowledge, this just might come in handy
Q: What type of web services does AppMachine support?
We support REST Based web services.
Q: I need to secure my web service, what types of authentication do you support?
You can secure your web service with the following authentication methods:
- OAuth 2.0: This one is fully supported and is the preferred method.
- OAuth 1.0: We recommend you to use OAuth 2.0, but we also support OAuth 1.0.
- API Keys: Can be used to secure your web service with one or more static API Keys.
Q: I get an error while I'm trying to import my web service into my app, what should I do?
Web services can be tricky to deal with, that's why we did spend so much time on our Pro version. So it could be that we missed your specific case, but to make sure you can just use one of these sites to validate the result of your web service call:
- For JSON based web services : http://jsonformatter.curiousconcept.com/
- For XML based web services: http://validator.w3.org
If the result is ok, please contact us at support@appmachine.com with your specific webservice.
Q: What will happen with the result of my web service?
When the device received a result from your web service it will be stored encrypted on the device of the app user. Even if the user is offline, the next time he opens the app, your web service data is still available and will be shown.
Q: SOAP web services are not supported at the moment, are they going to be?
Probably, we are looking into supporting SOAP web services as well, but we do not have an estimated delivery date.
Q: What type of HTTP Methods do you support?
- GET
- POST
- PUT
- DELETE
- PATCH
Q: Will the devices directly connect to my web service?
You have two options:
- Make it a live web service, this will cause the devices to connect directly to your web service. This might be useful when you are working with data that changes frequently. Or where the result of the web service depends on user input.
- Make it a semi live web service, this will cause our servers to connect to your web service. The result will be stored securely in our content delivery network and we will take care of the distribution to the apps. When you are using this option you can schedule an interval in which we will update the data.
Q: Will the data retrieved from my web service be available when my users are offline?
Yes, once the data has been downloaded just once, the user will always be able to access the data, even if they are offline. Once they get back online the data will be updated.
Q: How to adjust the datatype of a field after I've uploaded my Excel document or added my web service?
In some cases you might need to adjust the data type of a field after you've done the initial import. To do so, please follow these simple steps:
- Select the Excel or Web Service building block;
- Click the "..." button next to the "Dataprovider" field;
- Select the "Output parameters" tab;
- Locate the field or fields of whom the data types should be changed and click the "Edit" button;
- Select the desired data type and click "OK";
- Click "Save";
- You can repeat step four and five to edit multiple fields at once. When you are done click the close button in the top right corner of the pop-up;
Q: Can I access the devices geolocation data and send it to my web service?
Yes!
- Add a Web Service block
- Choose "Custom Web Service"
- When defining your web service, go to the Query section at the bottom and click on the "Default Value" drop down
- Select the geolocation information you'd like to send to your web service.
Comments
5 comments
great info thanks.
PHP | Parents Helping Parents
Please see my related comment at http://support.appmachine.com/entries/43761328-How-To-Import-your-data-via-a-web-service?
If you are a WordPress user, have a look at: https://wordpress.org/plugins/json-rest-api/
This plugin will become standard in the core of WordPress 4.0. The documentation can be found at: http://wp-api.org/. It seems not to be complete yet, since it mostly handles posts, media and users. For example to get a specific page out of WordPress, use:
http://www.xxxx.com/wp-json/pages/<id>
or
http://www.xxxx.com/wp-json/pages/<slug>
Hi Peter,
Thank you for the great tip. Integrating your WordPress site and articles is really easy with our Web Service block, especially for hosted WordPress sites (http://developer.wordpress.com/docs/api/).
Keep in mind that the JSON implementation of wordpress.com differs in its format, for example:
https://public-api.wordpress.com/rest/v1/sites/www.printmedianieuws.nl/posts/
the line abobe is to get all the posts from printmedianieuws.nl. To get a simular list with the JSON REST API from wordpress.org, you need something like: http://www.luit.nl/wp-json/posts
To use the wordpress.com implementation, you need the JetPack plugin. I don't recomment that one, since it is a heavy load on you website. The JSON REST API (https://wordpress.org/plugins/json-rest-api/) is a better choice.
Please sign in to leave a comment.