The web service interface of the fi-domain name service
Web service interface is a machine-readable interface, which enables the registration, renewal and making changes to a domain name without a browser-based user interface. The interface is meant to be used by service providers, for example to speed up the registration of domain names.
The service interface fulfils the WS-I Basic Profile 1.1 standard. The service description can be downloaded here:
Service description [PDF, 158 KB]
Web service demo client (.NET) [ZIP, 121 KB]
Web service demo client (JAVA) [ZIP, 448 KB]
Web service demo client (PHP) [ZIP, 5 KB]
Wsdl description of the service
Web Services Description Language (wsdl) describes the web service interface from the application developer's viewpoint. The wsdl description can be downloaded here:
https://domainws.ficora.fi/fidomain/DomainNameWS_FicoraDomainNameWS.svc?wsdl
Possibilities brought by ws interface
The Web Service interface can be used by service providers to perform the following tasks related to fi domain names:
- Applying for a new domain name
- Renewing your domain name
- Changing name servers for a domain name
- Deleting the name servers of a service provider from a domain name
Access rights
In order to use the Web Service interface, the service provider needs to contact the customer service department of the domain name system. The customer service department opens a so-called Web Service account for the service provider, enabling the service provider to perform tasks on the WS interface that are liable to a charge. The customer service department also sends the encryption key to the service provider required for the use of the interface by mail.
Paying for a domain name with the web service
The web service interface introduces a new payment method, "advance payment". In order to be able to use the fee-based functions of the interface, service providers must have transferred a sum of their choice to their user account in advance. This sum can then be spent for registering domain names etc. The advance payment is paid with the domain name service. The advance payment can be spent for registration and renewal of domain names with the web service only, not with the domain name service.
At this stage, the advance payment cannot be used to cover fee-based services with the domain name service.
Authentication
Each XML message to be sent contains a so-called message context that includes a user name, a time stamp and a MAC code. These fields are used when the service authenticates an incoming service request.
Username
The user name that is added to an XML message is the same name that the service provider uses when logging into the domain name system.
Encryption key (shared key)
The encryption key is a string that consists of 24 characters. The customer service of the domain name system delivers it to the service provider by mail.
Requirements for the use of service
- A customer programme that supports the WS-I Basic Profile 1.1 standard and which fulfils the requirements set in the service description.
- The service provider has registered as a service provider with the fi-domain name service at https://domain.ficora.fi/.
- Activation of ws account
- Encryption key - an encryption key is a string that consists of 24 characters. The customer service of the domain name system delivers it to the service provider by mail.
Web Service testing
The Web Service has a testing service, which functions identically with the actual production version. However, changes and additions will not be updated in the production version, neither is the service provider's actual Web Service account debited.
The Web Service test system is found at the address:
https://domainws.ficora.fi/fidomaintest/DomainNameWS_FicoraDomainNameWS.svc
The 24-character encryption key is the same for all service providers:
1111 1111 1111 1111 1111 1111 (delete the empty spaces).
The user name that is added to an XML message is the same name that the service provider uses when logging into the domain name system and the production version.
A sum of 100.000 euros will be added onto each of the service providers' Web Service test system account. It is possible to add more value, if necessary. In problem situations, please send an e-mail to fi-domain-tech@ficora.fi. Please also attach the sent and received XML-message to speed the problem solving.
Service providers who have not reported that they wish to take the Web Service in their use do not either have a Web Service test account. In these cases, please send an e-mail to the above-mentioned e-mail address to receive a Web Service test account.
