API Admin Interface/en

Aus EUserv Wiki

(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(General)
(General)
Zeile 11: Zeile 11:
The API is similar to a remote control, which independently set from EUserv customer center. To be able to undertake the setting of second person, without disclosing your entire customer service center. This is an advantage particularly for Reseller, because their customers can make the settings independent.
The API is similar to a remote control, which independently set from EUserv customer center. To be able to undertake the setting of second person, without disclosing your entire customer service center. This is an advantage particularly for Reseller, because their customers can make the settings independent.
-
This guide we have created for you in the "API Sandbox". The sandbox is a testing environment and is analogous to the "Live API" to use. We recommend you first attempts and settings perform a test basis in the sandbox because your live system is not affected, but even if incorrect settings are made.
+
This guide we have created for you in the "API Sandbox". The sandbox is a testing environment and is analogous to the "Live API" to use. We recommend you first the attempts and settings perform a test basis in the sandbox because your live system is not affected, but even if incorrect settings are made.
== Setting up the API Administration ==
== Setting up the API Administration ==

Version vom 12:33, 8. Okt. 2012

API Administration

Inhaltsverzeichnis

API Administration

General

If you have an EUserv server or domain, you have the possibility to set up in customer service center as well as the EUserv API.

The API is similar to a remote control, which independently set from EUserv customer center. To be able to undertake the setting of second person, without disclosing your entire customer service center. This is an advantage particularly for Reseller, because their customers can make the settings independent.

This guide we have created for you in the "API Sandbox". The sandbox is a testing environment and is analogous to the "Live API" to use. We recommend you first the attempts and settings perform a test basis in the sandbox because your live system is not affected, but even if incorrect settings are made.

Setting up the API Administration

In EUserv customer center, you have the possibility of making settings for your API Administration.

Choose "API-Verwaltung" in the main menu on the left.

Datei:reseller-api-sandbox_kc-waehlen_572x.png


Now you can choose between "API Live", "API Sandbox" and "API Dokumentation". All the settings you make in "API Live" will be immediately implemented and "scharf" are switched.

Datei:reseller-api-kc_572x.png



Setting the API

To use the API, you can click on the link in the customer center (https://api.test.euserv.net/admin/) behind "API admin interface." Then, you are directed to the login page of the API.

Datei:reseller-api-sandbox_login_572x.png



On this log in is provided in the customer center with the user's data. On the overview page you get the API user profiles.

Datei:reseller-api-sandbox_blanko_572x.png



Creating the User API

By clicking "Neuen Benutzer Anlegen" you have the possibility to create a new user for your API.

Datei:reseller-api-sandbox_newuser_572x.png



Now you need to define your user. As "Login name" the user name is called. Enter a name, that allows you to assign to the user clearly. A secure password will be generated automatically. Under "Status" you determine whether the user is active or inactive, i.e., whether the user profile can be used or not. If you switch the user to inactive and save the settings to take effect, however, the user's profile cannot be used yet.

In "berechtigte IPs" will define the IP addresses that are authorized to access this user profile. If the user has a fixed IP address, then enter it there for example: 127.0.0.1.

Datei:reseller-api-sandbox_newuser-anlegen+feste-ip_572x.png



If your user has no fixed IP address, enter the wildcard "0.0.0.0". Please note that all IP addresses can access with username and password on your API - it's safer if you can define a fixed IP address.

Datei:reseller-api-sandbox_newuser-anlegen+wildcard_572x.png



Put another check in the "Domain" or "Server", depending on which tariff is to act for your API.

Click "Änderungen speichern" to apply the settings.

Editing the User API

If you have already created a user of your API and want to edit it, then click back to the appropriate user profile on "View/Edit".

Datei:reseller-api-sandbox_viewuser_572x.png



You can now let the user profile to generate a new password to change the status that define authorized IP address or assign a group.

Click "Änderungen speichern" to save the changes.

Datei:reseller-api-sandbox_edituser_new-pw_572x.png