docTBS Internet API reference Documentaiton - TBS
download 
Plainte Transcription
TBS Internet API reference Documentaiton - TBS
API TBS XML-RPC The content of this manual is the property of TBS INTERNET, all rights reserved. All reproduction, copy or mirroring prohibited. V1.2.2 IPv4 Operations Base URL : https://apisandbox6.or2.clust2.tbs-internet.net Application : api-operations.php Methodes : Name: achat renouvellement refabrication revocation dcvEmailRenvoyer dcvCodeValidation (IPv6 Sandbox) Purpose: order renew reissue revocation Email DCV Resending Email DCV Code Validation Information Base URL : https://apisandbox6.or2.clust2.tbs-internet.net Application : api-infos.php Methodes : Name: statut solde enSommeil reference dcvAdresses (IPv6 Sandbox) Purpose: Status Balance Asleep Reference DCV Addresses IPv4 Operations Base URL : https://apisandbox4.or2.clust2.tbs-internet.net:1443 Application : api-operations.php Methodes : Name: achat renouvellement refabrication revocation dcvEmailRenvoyer dcvCodeValidation (Sandbox IPv4) Purpose: order renew reissue revocation Email DCV Resending Email DCV Code Validation Information Base URL : https://apisandbox4.or2.clust2.tbs-internet.net:1443 Application : api-infos.php Methodes : Name: statut solde enSommeil reference dcvAdresses (Sandbox IPv4) Purpose: Status Balance Asleep Reference DCV Addresses Page 1 API xml-rpc 3 methods : achat(order), renouvellement(renew), refabrication(reissue) Achat/Order Descriptions Parameters identification demande Mandatory Yes Yes Type Struct Struct Default user, Password For bulk purchases, one structure per request Parameters identification demande Renouvellement/Renew Descriptions Utilisateur, mot de passe For bulk purchases, one structure per request Mandatory Yes Yes Type Struct Struct Default Parameters identification demande Refabrication/Reissue Descriptions Utilisateur, mot de passe For bulk purchases, one structure per request Mandatory Yes Yes Type Struct Struct Mandatory Yes Yes Type String String Parameters utilisateur motDePasse identification Descriptions Username Password Page 2 Default demande (achat) EXCEPT for products X509EmailPart and client certificates with invitation Parameters Descriptions Mandatory Type refDemande Request reference Mandatory en case of bulk order. No String produit Product Code + lifetime : product1 for one year Yes Struct requete Fields: Logiciel, licence, CSR ou SPKAC, Yes Struct domainePrincipal, domaines, cloneTBS, accompagnement,DCV No detailsRequete mandatory with a SPKAC Struct organisation See page 2 Yes Struct contactAdm See page 2 Yes Struct contactTech See page 2 No Struct If not precised, the Administrative Contact will fill both roles. compagnieFact By default, the organization No Struct paiement Fields: codePaiement, devis Yes Struct divers Fields : Code promo, instruction, ref Client No Struct Parameters refDemande produit requete detailsRequete contactPart compagnieFact paiement divers Parameters refDemande produit invitation detailsInvitation contactPart compagnieFact paiement divers demande (achat) ONLY for products X509EmailPart without invitation Descriptions Mandatory Request reference Mandatory en case of bulk order. No Product Code + lifetime : product1 for one year Yes Fields: Logiciel, CSR or SPKAC Yes mandatory with a SPKAC No See page 2 Yes By default, the organization No Fields: codePaiement, devis Yes Fields : Code promo, instruction, ref Client No demande (achat) Certificat client avec invitation Descriptions Request reference Mandatory en case of bulk order. Product Code + lifetime : product1 for one year Message, csp, lg clé, statut clé privé Contenu de la demande Voir page 2 By default, the organization Fields: codePaiement, devis Fields : Code promo, instruction, ref Client Page 3 Mandatory No Yes Yes Yes Yes No Yes No Default Type String Struct Struct Struct Struct Struct Struct Struct Default Type String Struct Struct Struct Struct Struct Struct Struct Default Parameters refDemande certificat produit requete organisation contactAdm contactTech compagnieFact paiement divers Parameters refDemande certificat requete contactTech divers Parameters refCA refTBS Parameters code dureeVie Parameters logiciel nbLicence CSR domainePrincipal domaines cloneTBS accompagnement adresseDVC demande (renouvellement) Descriptions Request reference Mandatory en case of bulk order. Reference of the certificate to renew Code , durée de vie Fields : Logiciel, licence, CSR suivant logiciel, domainePrincipal, domaines, cloneTBS, accompagnement, DCV See page 2 See page 2 See page 2 If not precised, the Administrative Contact will fill both roles. By default, the organization Fields: codePaiement, devis Fields : Code promo, instruction, ref Client demande (refabrication) Descriptions Request reference Mandatory en case of bulk order. Reference of the certificate to renew Logiciel, CSR, domainePrincipal, domaines, cloneTBS, DCV Voir page 2 Fields: instruction, ref Client, raison de refabrication certificat Descriptions CA Reference of the certificate to renew or reissue (Mandatory except if refTBS) TBS Reference of the certificate to renew or reissue (Mandatory except if refCA) Produit Descriptions Product Code (see annex) Product Lifetime : 1, 2, 3 (years), or 90 (days) depending on the product Requete Descriptions Product Code (see annex) Additional licenses number (if applicable) Mandatory No Yes Yes Yes Type String Struct Struct Struct Yes Yes No Struct Struct Struct No Yes No Struct Struct Struct Mandatory No Yes Yes Type String Struct Struct No No Struct Struct Mandatory Yes Type String Yes String Mandatory Yes No Type String Int Default Mandatory Yes No Yes No No Type String Int String String String Default main domain or a multidomain certificate Mandatory for multidomain certificates (1 domain per line) Ignored if cloneTBS refTBS of monoCN orders clonned in a multiCN cert No (1 ref per line) Guidance option : oui (yes) or non (no) No Valid email address (see https://www.tbsYes certificates.co.uk/FAQ/en/challenge_dcv.html) Or another validation method : Valid Email - HTTP_CSR_HASH (validation by placing a file on the or root of your HTTP server), HTTP_ - HTTPS_CSR_HASH (identical to HTTP_CSR_HASH but CSR_HASH using HTTPS) or - CNAME_CSR_HASH (validation by adding a CNAME HTTPS_CSR entry in the domain's DNS zone). _HASH or CNAME_ A list of valid email addresses can be obtained by the CSR_HASH result of the API method dcvAdresses (see further) For multidomain products : 1 addresse per ligne (in the same order than the domaines parameter) . (Necessary for TBS X509, Comodo,and PositiveSSL products) detailsRequete (ignored if a CSR was provided, mandatory with SPKAC) Page 4 Default Default 1 0 String String String No No Parameters spkacCN spkacEmail spkacO spkacOU spkacSTREET1 spkacSTREET2 spkacSTREET3 spkacPOBox spkacPostalCode spkacL spkacC spkacST spkacTelephone spkacUserId Parameters csrExternalise messageCSRExter csp keySize exportable userProtected imposeIE Descriptions Common Name Email Address Organization legal name Division/Unit/Department Organization Address Organization Address Organization Address POBox Postal Code Locality/City Country (iso-3166) State/Province/Département Phone Number Identification Mandatory Yes Yes Variable suivant type de certificat Voir annexe Yes Yes Yes No No No invitation ( Ignored with csrExternalise ='non' or if csrExternalise was not provided) Descriptions Mandatory Invitation Flag : oui (yes) or non (no) Yes Your message for the invitation recipient No CPS name if imposed No Key Size if imposed No Exportable flag if necessary : oui (yes) or non (no) No No Protected key flag if necessary : oui (yes) or non (no) Forcing Internet Explorer Flag : oui (yes) or non (no) No Type String String String String String String String String String String String String String String Default Type String String String Int String String String Default Non Non Non Non detailsInvitation ( Ignored with csrExternalise ='non' or if csrExternalise was not provided) See in the annex: CSR fields for X509 Email and X509 Sign&Login numTVA siteWeb Organisation Descriptions Mandatory Organization National Identification Number, i.e. SIREN for No France See Annex No Legal Name Yes Headquarters Address Yes Headquarters Address No Headquarters Address No Headquarters Address Yes Headquarters Address Yes See annex (iso-3166) No Main Phone Number Yes Main Fax Number No French Organization type Code (only for French No organizations) VAT number No Website No Parameters civiliteAdm contactAdm Descriptions 0 : M. / 1 : Mrs. / 2 : Miss Parameters siren typeOrg nom adresse1 adresse2 adresse3 ville codePostal pays telephone fax codeNAF Mandatory Yes Page 5 Type String String String String String String String String String String String String Default FR String String Type String Default nomAdm prenomAdm fonctionAdm telAdm emailAdm Lastname Firstname Job Title Direct Phone Number Direct Email Address Yes Yes Yes Yes Yes String String String String String Parameters civiliteTech nomTech prenomTech fonctionTech telTech emailTech contactTech Descriptions 0 : M. / 1 : Mrs. / 2 : Miss Lastname Firstname Job Title Direct Phone Number Direct Email Address Mandatory Yes Yes Yes Yes Yes Yes Type String String String String String String Default Parameters civiliteRespLegal nomRespLegal prenomRespLegal fonctionRespLegal telRespLegal emailRespLegal contactRespLegal Descriptions 0 : M. / 1 : Mrs. / 2 : Miss Lastname Firstname Job Title Direct Phone Number Direct Email Address Mandatory Yes Yes Yes Yes Yes Yes Type String String String String String String Default Mandatory Yes Yes Yes Type String String String Default Part Parameters nomPart prenomPart telPart Descriptions Lastname Firstname Direct Phone Number compagnieFact (Payment facility) Page 6 Parameters numTVA melCompta Descriptions Mandatory Organization National Identification Number, i.e. SIREN for No France Legal Name Yes Headquarters Address Yes Headquarters Address No No Headquarters Address Headquarters Address Yes Headquarters Address Yes See annex (iso-3166) No Main Phone Number Yes French Organization type Code (only for French No organizations) VAT number No No Accounting department's e-mail Parameters modePaiement devis paiement Descriptions Payment method, see Annex Quotation : yes (oui) or non (no) siren nom adresse1 adresse2 adresse3 ville codePostal pays telephone codeNAF Parameters banque porteur carte date crypt Parameters codePromo notesClient refClient raisonRefab Carte bancaire (Credit Card) Descriptions Bank Name Card Holder Name Card number expiration-date (yymm) Card Validation Code/Card Verification Value/Unique Card Code divers (misc) Descriptions Promotional Code If you want to leave specific notes Your reference that can be used to identify orders Reissue reason Type String String String String String String String String String String Default FR String String Mandatory Yes No Type String String Default Mandatory Yes Yes Yes Yes Yes Type String String String String String Default Mandatory No No No No Type String String String String Default Mandatory No Yes Yes No No Type String Int String String String Default Non Responses Parameters refDemande codeReponse messageReponse refTBS refCA Descriptions Bulk Order references Response code, see anenx Response message TBS reference (10 numbers) CA Reference if available Page 7 ANNEXES Product codes Code Nom Produit acc fafcaen fafparis fafpariscli exp COMs2ssl COMs2ev COMs2protest COMs2ev3fqdn sanCOMev3fqdnSHA256 COM12s2ucc sanCOM12uccSHA256 COM3s2ucc sanCOM3uccSHA256 COMs2wild COMevSHA256 COMhp COMhp30 COMvpro sslev rensslev sansslev ssl renssl sanssl wssl renwssl dev rendev devair rendevair secureev sansecureev globalev sanglobalev secure sansecure global sanglobal vsdev vstso vswild audacio tbizwild rentruebiz truebiz tbidev globextssl sanglobextssl globorgssl globovwssl globucc3 sanglobucc3 cdsdept cdspers Psbasic Psbasicwild PSbasicW PSbasicWtest PSfreeW certiSSLRGS SANcertiRGS certiSSLcli certiCachetDoc certiID1LRGS certiID2TRGS certiID3TRGS X509m12domSHA256 Guidance Option Face to Face RGS at TBS Caen Face to Face RGS at a Partners at Paris Face to Face RGS at your Organization's Paris HQ Express Option Comodo SSL SHA256 Comodo EV SSL SHA256 Comodo Test SSL SHA256 Comodo EV Multiple Site (3+) SHA256 Comodo SAN additionnel EV Multiple Sites (3+) SHA256 Comodo UCC SHA256 (12+) Comodo additional SAN UCC (12+) SHA256 Comodo UCC SHA256 (3+) Comodo additional SAN UCC (3+) SHA256 Comodo WildSSL SHA256 Comodo EV SHA256 Comodo HackerProof Comodo HackerProof Test Comodo Intel vPro Thawte SSL EV Thawte renew SSL EV Thawte SSL EV additional SAN Thawte SSL Standard Thawte renew SSL Standard Thawte SSL Standard additional SAN Thawte SSL Wildcard Thawte renew SSL Wildcard Thawte Developpeur Thawte renew Developpeur Thawte Adobe Air Developpeur Thawte renew Adobe Air Developpeur Symantec Secure Site EV Symantec Secure Site EV additionalSAN Symantec Secure Site Pro EV Symantec Secure Site Pro EV additional SAN Symantec SSL Secure Symantec Secure Site additional SAN Symantec SSL Secure Site Pro Symantec Secure Site Pro additionalSAN Symantec Developpeur Symantec Norton Secured Seal Symantec Secure Site Wildcard ChamberSign Audacio 2* USB Geotrust True BusinessID Wildcard Geotrust renouvellement True BusinessID Geotrust True BusinessID Geotrust True BusinessID with EV GlobalSign ExtendedSSL GlobalSign additional SAN ExtendedSSL GlobalSign OrganizationSSL SHA256 GlobalSign OrganizationSSL Wildcard GlobalSign UCC 3+ GlobalSign additional SAN UCC3+ GlobalSign PDF Signing Services GlobalSign PDF Signing Individus Positive SSL Basic DV Positive SSL Basic DV Wildcard Positive SSL Basic DV Web Positive SSL Basic DV Web test Positive SSL Free DV Web Certigna SSL RGS* Certigna RGS additional SAN Certigna Serveur Client Certigna Cachet Serveur Documents Certigna ID RGS* Logiciel Certigna ID RGS** on token Certigna ID RGS*** on token TBS X509 12 Multiples Sites SHA256 Page 8 Lifetime Licences? 1-2-3 1-2 30j 1-2 1-2 1-2-3 1-2-3 1-2-3 1-2-3 1-2-3 1-2 1-2 30j 1-2-3 1-2 1-2 1-2 1-2-3 1-2-3 1-2-3 1-2 1-2 1-2 1-2 1-2 1-2 1-2 1-2 1-2 1-2 1-2-3 1-2-3 1-2-3 1-2-2 1-2-3 1-2-3 1-2-3 3 1-2-3 1-2-3 1-2-3 1-2 1-2 1-2 1-2-3 1-2-3 1-2-3 1-2-3 1-2-3 1-2-3 1-2-3 1-2-3 1-2-3 30j 90j 1-2-3 1-2-3 1-2-3 1-2-3 1-2-3 1-2-3 1-2-3 1-2-3 No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No Yes No Yes No Yes No Yes No No No Yes No No No No No No No No No No No No No No No No No No No No No No No No No No sanX509m12domSHA256 X509s2m40dom sanX509m40domSHA256 X509s2m100dom sanX509m100domSHA256 X509wildSHA256 X509SHA256e X509s2test X509SHA256p X509SHA256s X509EmailNovice X509EmailTest X509s2Email X509s2SignLogin X509SignLoginTest256 X509PKIdiam X509PKIem X509PKIor TBS X509 SAN additionnel Multiple Site (12+) SHA256 TBS X509 40 Multiples Sites SHA256 TBS X509 additional SAN Multiple Site (40+) SHA256 TBS X509 100 Multiples Sites SHA256 TBS X509 additional SAN Multiple Site (100+) SHA256 TBS X509 Omnidomain SHA256 TBS X509 Ecommerce SHA256 TBS X509 Test SHA256 TBS X509 Premium SHA256 TBS X509 Standard SHA256 X509 Email Novice TBS SHA256 X509 Email Professionnal Test TBS SHA256 TBS X509 Email Professionnal SHA256 TBS X509 Sign&Login SHA256 TBS X509 Sign&Login Test SHA256 Compte X509 PKI Diamant (5000 points) Compte X509 PKI Emeraude (200 points) Compte X509 PKI Or (1000 points) 1-2-3 1-2-3 1-2-3 1-2-3 1-2-3 1-2-3 1-2-3 30j 1-2-3 1-2-3 1 30j 1-2-3 1-2-3 30j No No No No No Yes No No No No No No No No No No No No Software Nom 4D Server / Business Kit A.I.R.S Délib de Digitech Alteon SSL Accelerator & VPN AOL Apache 2.4.8+ Apache 2.x Apache release 1 OVH (RH7.2) Apache release 2 OVH (gentoo) Apache-ModSSL Apple Mac OSX Server Autre logiciel Aventail SSL VPN Axiliance RealSentry v2.x ou v3.x Bee-Ware i-Sentry v3.x ou v4.x Blue Coat / Cacheflow BoostEdge Cegid Web Access Server CFT (synchrony transfer) Check Point VPN-1 Cisco Access Control Server Cisco ASA Cisco Content Services Switch Cisco Mobility Server Cisco Secure Content Accelerators Cisco SSL Service Module Cisco VPN 3000 Series Cisco Wireless LAN Controller Citrix Access Essentials Citrix Access Gateway Citrix NetScaler Citrix Secure Gateway Cobalt Raq Communigate Pro Covalent Server Software CPanel DenyALL rWeb DirectAdmin Web Control Panel Dovecot Ensim F5 Big-IP SSL F5 FirePass F5 VPN FileZillaServer Globalscape Secure FTP Server H-Sphere HAProxy HP/Compaq iTP Secure WebServer IBM Communications Server IBM HTTP Server IBM Internet Connection Server Code 4D Delib Alteon AOL Apache24 Apache2 ApacheOVH ApacheOVH2 ModSSL OSX AutreLogiciel Aventail RealSentry iSentry BlueCoat BoostEdge CegidWAS CFT CheckPointVPNONE CiscoACS CiscoASA CiscoCSS CiscoMS CiscoSCA CiscoSSL CiscoVPN CiscoWLC CitrixAE CitrixAG CitrixNS CitrixSG Cobalt Stalker Covalent CPanel DenyALL DirectAdmin Dovecot Ensim F5SSL F5FirePass F5VPN Filezilla FTP HSphere HAPRoxy HpiTP IBMCOMM IBMHTTP IBM Page 9 IBM WebSphere Inet/400 servers InterWorx Node/SiteWorx Iparapheur de Adullact Ipswitch Filetransfer Ipswitch Imail Server ISPConfig Java Web Server (Javasoft / Sun) Jetty Java HTTP Servlet Web Server Juniper Secure Access Kerio Connect Kerio Control Kerio Webstar 5 Lotus Domino Lotus Domino 9+ Lotus Domino Go! Mailtraq Microsoft Authenticode Microsoft CRM 4 sur IIS 7.x Microsoft Exchange 2003 Microsoft Exchange 2007 Microsoft Exchange 2010 Microsoft Exchange 2013 Microsoft IIS 5.x Microsoft IIS 6.x Microsoft IIS 7.x Microsoft IIS 8.x Microsoft Internet Explorer Microsoft ISA Microsoft Lync 2010/2013 Microsoft Office Communication server 2007 Microsoft Sharepoint 2010 (IIS 7.x) Microsoft Sharepoint 2013 (IIS 8.x) Microsoft Small Business Server 2008/2011 Microsoft TMG 2010 Microsoft UAG 2010 Microsoft Windows Azure Mirapoint Message Server Netasq Netgear SSL VPN Netscreen SSL VPN Nginx OpenSSL compatible Oracle Oracle Java Oracle Wallet Manager Plesk Postfix R3 SSL Server Raven SSL RedHat Linux Roxen SAP Web Application Server SonicWall SSL VPN Squid 2.5+ Sun One Sybase EAserver TinySSL Tomcat Tomcat+Apache (APR) VBA Developer VMWare View WatchGuard Web Crossing WebMethods Webmin Zeus Web Server Zimbra Zope Web Server Zyxel Zywall Microsoft Internet Explorer Mozilla Firefox Page 10 WebSphere Inetstore InterWorx Iparapheur WSFTP Imail ISPConfig JavaWebServer Jetty JuniperSA KeiroConnect KeiroControl Webstar5 Domino Domino9+ Go Mailtraq MSAuthentiCode MScrm4IIS7 MSExch2003 MSExch2007 MSExch2010 MSExch2013 MSIIS5 MSIIS6 MSIIS7 MSIIS8 Internet Explorer MSISA MSLync2010 MSOCS2007 MSsharepIIS7 MSsharepIIS8 MSSBS2008 MSTMG MSUAG2010 MSAzure Mirapoint Netasq NetgearVPN Netscreen nginx OpenSSL Oracle JavaSoftDev OracleWallet Plesk Postfix R3 Raven RedHat Roxen SAP SonicSSLVPN Squid SunOne SybaseEAserver TinySSL Tomcat TomcatAPR VBADevCert VMWareView WatchGuard WebCrossing WebMethods Webmin Zeus Zimbra Zope Zyxel MSIE Mozilla Firefox Safari Safari Organization Type Country Code (iso 3166) FR FR FR FR FR FR AD AD AD AT AT AT BE BE BE BE BE CA CA CA CA CH CH CH CH CH CY CY CZ CZ CZ DE DE DE EE EE ES ES ES GB GB GB GB GB GB GB IE IE IE IE IE IE IS IS IT IT IT LU LU LU MC MC MC MC MT NL NL NL NZ NZ organization Type company listed on the commerce register 1901-law association with SIREN number 1901-law association without SIREN number public org., liberal profession, other natural person other without SIREN number natural person company listed on the commerce register Other Other company listed on the commerce register natural person natural person international association ASBL association company listed on the commerce register Other Registered company natural person Other QC: Registered company société non inscrite au registre du commerce Other company listed on the commerce register association natural person Other Registered company Other natural person company listed on the commerce register company listed on the commerce register Other natural person Registered company Other natural person company listed on the commerce register Other Charity registered in England or Wales Organization with a VAT number Charity natural person Registered company (Ltd/PLC) Other Charity registered in Scotland or Northern Ireland natural person Charity Other Registered company (Ltd/PLC) Non-registered company with a registered business name Organization with a VAT number Other Registered company natural person Registered company Other natural person Other company listed on the commerce register natural person Other company listed on the commerce register association Registered company Registered organization natural person Other Other natural person Page 11 code FRRCS FRASSIREN FRASSO FRSIREN FRPERSO FRAUTRE ADPERSO ADRCS ADOTHER ATOTHER ATWKO ATPERSO BEPERSO BEASSOINT BEASBL BERCS BEAUTRE CACORP CAPERSO CAOTHER CAQCNEQ CHNRCS CHAUTRE CHRCS CHASSO CHPERSO CYOTHER CYREG CZAUTRE CZPERSO CZRCS DERCS DEOTHER DEPERSO EECORP EEOTHER ESPERSO ESRCS ESOTHER GBCHAR1 GBVAT GBNGO GBPERSO GBCOMPH GBOTHER GBCHAR2 IEPERSO IECHAR IEOTHER IECRO IECRO2 IEVAT ISOTHER ISREG ITPERSO ITREG ITOTHER LUPERSO LUOTHER LURCS MCPERSO MCAUTRE MCRCS MCASSO MTREG NLKVK NLPERSO NLOTHER NZOTHER NZPERSO NZ RO RO ?? ?? ?? Registered company Registered company Other Other natural person company listed on the commerce register NZCOMPH ROREG ROOTHER XXAUTRE XXPERSO XXRCS Country Country Iso 3166 AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CS CU CV CY CZ DE DJ DK DM DO DZ EC EE Andorra United Arab Emirates Afghanistan Antigua and Barbuda Anguilla Albania Armenia Netherlands Antilles Angola Antartica Argentina American Samoa Austria Australia Aruba Aland Islands Azerbaijan Bosnia and Herzegovina Barbados Bangladesh Belgium Burkina Faso Bulgaria Bahrain Burundi Benin Saint Barthelemy Bermuda Brunei Bolivia Brazil Bahamas Bhutan Bouvet Island Botswana Belarus Belize Canada Cocos (Keeling) Islands Congo, Republic of Central African Republic Congo Switzerland Ivory coast Cook Islands Chile Cameroon China Colombia Costa Rica Serbia and Montenegro Cuba Cape Verde Chypre Czech Republic Germany Djibouti Denmark Dominica Dominican Republic Algeria Ecuador Estonia Page 12 Egypt Western Sahara Eritrea Spain Ethiopia Finland Fiji Falkland Islands (Malvinas) Micronesia Faroe Islands France Gabon United Kingdom Grenada Georgia French Guiana Guernsey Ghana Gibraltar Greenland Gambia Guinea Guadeloupe Equatorial Guinea Greece South Georgia and the South Sandwich Islands Guatemala Guam Guinea-Bissau Guyana Hong Kong Heard Island and McDonald Islands Honduras Croatia Croatia Hungary Indonesia Ireland Israel Isle of Man India British Indian Ocean Territory Iraq Iran Iceland Italy Jersey Jamaica Jordan Japan Kenya Kyrgystan Cambodia Kiribati Comoros Saint Kitts et Nevis Korea, Democratic People Republic of Korean, Republic of Kuwait Cayman Islands Kazakhstan LAO people's democratic rep Lebanon Saint Lucia Liechtenstein Sri Lanka Liberia Lesotho Lithuania Luxembourg Latvia Libyan Arab Jamahiriya Morocco Page 13 EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA Monaco Moldova Montenegro Saint Martin Madagascar Marshall Islands Macedonia Mali Myanmar Mongolia Macao Northern Mariana Islands Martinique Mauritania Montserrat Malte Mauritius Maldives Malawi Mexico Malaysia Mozambique Namibia New Caledonia Niger Norfolk Nigeria Nicaragua Netherlands Norway Nepal Nauru Niue New Zealand Oman Panama Peru French Polynesia Papua New Guinea Philippines Pakistan Poland Saint Piere and Miquelon Pitcairn Puerto Rico Palestinian Territory, occupied Portugal Palau Paraguay Qatar Reunion Romania Serbia Russian Federation Rwanda Saudi Arabia Solomon Islands Seychelles Soudan Sweden Singapore Saint Helena Slovenia Svalbard and Jan Mayen Slovakia Sierra Leone San Marino Senegal Somalia Suriname Sao Tome and Principe El Salvador Syrian Arab republic Swaziland MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR ST SV SY SZ Page 14 Turks and Caicos Islands Chad French Southern Territories Togo Thailand Tajikistan Tokelau Timor, East Turkmenistan Tunisia Tonga Turkey Trinidad ans Tabago Tuvalu Taiwan, Province of China Tanzania Ukraine Uganda United States Minor Outlying Islands United States of America Uruguay Uzbekistan Vatican City State Saint Vincent and the Grenadines Venezuela Virgin Islands, British Virgin Islands, U.S. Viet Nam Vanuatu Wallis and Futuna Samoa Yemen Mayotte South Africa Zambia Zimbabwe TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW Mode paiement 0cb Credit card (Visa, Mastercard or American Express) 0ch Cheque 0gr ' Free' mode 0ib IBAN Transfer 0mc Mandat Cash 0se One-off direct debit (within 5 days) 0sw SWIFT transfer 0py Bitcoin payment 0vi Bank transfer 10pa Recurrent direct debit (within 10 days) 30m 30 days net after delivery by ADMINISTRATIVE mean (+7%, mini: €29.00) 30v 30 days net after invoice delivery by bank transfer (+7%, mini: €29.00) 30 days from end-of-month of invoice on the 10th of following month by bank transfer (+8%, 30v10 mini: €29.00) 45v 45 days net after invoice delivery by bank transfer (+8%, mini: €29.00) 45 days from end-of-month of invoice on the 10th of following month by bank transfer (+9%, 45v10 mini: €29.00) 50m 50 days net after delivery by ADMINISTRATIVE mean (+9%, mini: €29.00) 60v 60 days net after invoice delivery by bank transfer (+9%, mini: €29.00) pre Pre-paid account Response codes < 0 : errors (Detailed in messageReponse) 0 : Online order 1 : registered Error Codes -1 Unauthorized User -2 Missing Reference -3 A renewal order has already been submitted. -4 This certificate expired more than three days ago Page 15 -5 Missing certificate to renew -6 The chosen product type does not correspond with the certificate to renew -7 Missing certificate reference to renew -8 A replacement request has been submitted (renew or reissue) -8a The certificate isn't reissueable (being ordered to the supplier) -8b The certificate isn't reissueable (expired) -8c The certificate isn't reissueable (revoked) -8d The client reference isn't unique -10 Missing product code -11 Invalid product code 12 One or more certificates are not valid: invalid reference(s) -13 Invalid domain list -14 Invalid main domain -20 Missing software -21 Missing licenses -22 Invalid CSR -23 Invalid private key -23a The private key must be 2048bits or more -24 Invalid CSR, the CN field format must be *.domain.tld -25 Invalid CSR, the CND field must not contain the character * -26 Vulnerable private key used to generate the CSR -27 Missing CN field in the CSR -28 Check the validation email address -29 Invalid CSR, the CN field contains a forbidden character (space, tab, line return) -30 Missing organization number -31 Check the SIREN (9 digits without spaces) -32 Missing organization name -33 Missing organization address -34 Missing organization postal code -35 Missing organization city -36 Check the organization phone number -37 Check the fax number -38 Missing NAF code -39 Check the Organization VAT number -50 Missing administrative contact first name -51 Missing administrative contact last name -52 Missing administrative contact job title -53 Check the administrative contact phone number -54 Check the administrative contact email address -55 Missing legal representative first name -56 Missing legal representative last name -57 Missing legal representative job title -58 Check the legal representative phone number -59 Check the legal representative email address -60 Missing technical contact first name -61 Missing technical contact last name -62 Missing technical contact job title -63 Check the technical contact phone number -64 Check the technical contact email address -70 Missing payment facility address -71 Missing payment facility postal code -72 Missing payment facility city -73 Check the payment facility phone number -74 Missing payment facility NAF code -75 Check the payment facility VAT number -76 Check the accounting service email address -80 Missing address -81 Missing a mandatory CSR field -82 Check the email address to certify -83 Check the sponsor email adderss -84 Forbidden field in the CSR -90 Invalid payment method -99 Debit/Credit card payment unsupported Page 16 -100 Invalid discount code -120 Missing C field in the CSR -121 The private key must be at least 2048bits -122 Missing ST field in the CSR -123 Impossible to use an ECC key for that kind of certificate -130 The certificate expires in more than 8 weeks -131 The certificate expires in more than 4 weeks -141 The certificate isn't reissueable (currently being ordered) -142 The certificate isn't reissueable (expired) -143 The certificate isn't reissueable (revoked) -150 Non-unique Client reference -170 None of your certificates is currently valid -171 This product is not part of your catalogue -172 This product's additional licenses are not part of your catalogue -173 This product's additional SAN are not part of your catalogue -174 The Guidance option is not part of your catalogue -200 Missing certificate reference -201 Access to this order denied -202 Invalid TBS reference -203 Invalid CA reference -204 Invalid reference -220 Missing domain -250 Missing certificate reference -251 Revokation unauthorized -252 La référence TBS n'est pas valide. -253 La référence CA n'est pas valide. -254 Unrevokable certificate (expired) -255 Unrevokable certificate (not currently valid) -256 Missing revokation reason -257 We cannot provide a Symantec product to a Japanese organization -304 Incorrect DCV email address or method -305 Unauthorized DCV email address -400 Missing Organization Identifier field in the CSR -401 Missing OU field in the CSR -402 Incorrect Organization Identifier field format -999 Undefined error Yes : Mandatory field Non: Forbidden Field Opt: Optional field (nt audited) Non-mentionned fields are FORBIDDEN X509 Email CSR Fields Name CN – Common Name Email O - Organisation OU – Organizational Unit STREET1 – Address STREET2 – Address STREET3 – Address POBox – Postal Box L – Locality/City PostalCode ST – State/Province/Département C – Country TelephoneNumber userId X509 Sign&Login CSR Fields Name Page 17 Pro. Novice Yes Yes Yes Opt Yes Opt Opt Opt Yes Yes Opt Yes Opt No No Yes No No No No No No No No No No No No SignLogin CN – Common Name Email OU – Organizational Unit STREET1 – Address STREET2 – Address STREET3 – Address POBox – Postal Box L – Locality/City PostalCode ST – State/ProvinceDépartement C – Country Yes Yes Opt Opt Opt Opt Opt Yes Opt Yes Yes Page 18 Method : revocation Parameters identification demande revocation Descriptions Utilisateur, mot de passe fields For Bulk purchases, one 'demande' per purchase identification Descriptions Mandatory Yes Yes Type Struct Struct Default Parameters utilisateur motDePasse Mandatory Yes Yes Type String String Default Username Password Parameters refDemande certificat raison demande Descriptions Mandatory in case of bulk purchases RefTBS, refCA Reissue reason Mandatory No Yes Yes Type String Struct String Default Parameters refTBS certificat Descriptions TBS Reference (10 numbers) Type String Default refCA CA Reference Mandatory Optional if refCA Optional if refTBS Mandatory Non Oui Oui Type String Int String String Response Parameters Descriptions refDemande Your reference for bulk purchases codeReponse See Annex messageReponse See Annex codeReponse MessageReponse 0 Revoked Certificate -1 Failure -251 You are not authorized to revoke the order -252 Invalid TBS reference -253 Invalid CA reference -254 Unrevokable certificate (expired) -255 Unrevokable certificate (not currently valid) -256 Missing revokation reason Page 19 Default 2 methods : dcvEmailRenvoyer (DCV resending) et dcvCodeValidation (DCV code validation) Parameters identification refTBS refClient dcvEmailRenvoyer Descriptions Utilisateur, mot de passe fields TBS reference(Mandatory except if refClient) Client Reference (Mandatory except if refTBS) Mandatory Yes Yes/No Yes/No Type Struct Struct Struct Default Parameters identification refTCA dcvCode dcvCodeValidation Descriptions Utilisateur, mot de passe fields CA Reference DCV code sent by email Mandatory Yes Yes/No Yes/No Type Struct Struct Struct Default Mandatory Yes Yes Type String String Default Parameters utilisateur motDePasse identification Descriptions Username Password Page 20 achat (order) <?xml version="1.0"?> <methodCall> <methodName>achat</methodName> <params> <param> <value><struct> <member><name>identification</name> <value><struct> <member><name>utilisateur</name> <value><string>nomUtilsateur</string></value> </member> <member><name>motDePasse</name> <value><string>pass</string></value> </member> </struct></value> </member> </struct></value> </param> <param> <value><struct> <member><name>ref demande</name> <value><struct> <member><name>produit</name> <value><struct> <member><name>code</name> <value><string>X509std</string></value> </member> <member><name>dureeVie</name> <value><int>1</int></value> </member> </struct></value> </member> <member><name>requete</name> <value><struct> <member><name>logiciel</name> <value><string>ModSSL</string></value> </member> <member><name>CSR</name> <value><string>-----BEGIN CERTIFICATE REQUEST----MIIBmjC... ...Xs -----END CERTIFICATE REQUEST-----</string></value> </member> </struct></value> </member> <member><name>organisation</name> <value><struct> <member><name>siren</name> <value><string>123456789</string></value> </member> <member><name>typeOrg</name> <value><string>FRRCS</string></value> </member> <member><name>nom</name> <value><string>organisation</string></value> </member> <member><name>adresse1</name> <value><string>rue</string></value> </member> <member><name>ville</name> <value><string>ville</string></value> </member> <member><name>codePostal</name> <value><string>12345</string></value> </member> <member><name>pays</name> <value><string>FR</string></value> </member> <member><name>telephone</name> <value><string>+33-1-23-45-67-89</string></value> </member> <member><name>codeNaf</name> <value><string>Z722A</string></value> </member> <member><name>numTVA</name> Page 21 <value><string>FR12123456789</string></value> </member> <member><name>siteWeb</name> <value><string>www.web.com</string></value> </member> </struct></value> </member> <member><name>contactAdm</name> <value><struct> <member><name>nomAdm</name> <value><string>Nom</string></value> </member> <member><name>prenomAdm</name> <value><string>Prenom</string></value> </member> <member><name>fonctionAdm</name> <value><string>Fonction</string></value> </member> <member><name>telAdm</name> <value><string>+33-1-23-45-67-89</string></value> </member> <member><name>emailAdm</name> <value><string>[email protected]</string></value> </member> </struct></value> </member> <member><name>paiement</name> <value><struct> <member><name>modePaiement</name> <value><string>pre</string></value> </member> </struct></value> </member> <member><name>divers</name> <value><struct> <member><name>notesClient</name> <value><string>Commande API</string></value> </member> </struct></value> </member> </struct></value> </member> </struct></value> </param> </params> </methodCall> Page 22 achat avec Invitation (order with invitation) <?xml version="1.0"?> <methodCall> <methodName>achat</methodName> <params> <param> <value><struct> <member><name>identification</name> <value><struct> <member><name>utilisateur</name> <value><string>nomUtilsateur</string></value> </member> <member><name>motDePasse</name> <value><string>pass</string></value> </member> </struct></value> </member> </struct></value> </param> <param> <value><struct> <member><name>ref demande</name> <value><struct> <member><name>produit</name> <value><struct> <member><name>code</name> <value><string>X509SignLogin</string></value> </member> <member><name>dureeVie</name> <value><int>1</int></value> </member> </struct></value> </member> <member><name>invitation</name> <value><struct> <member><name>csrExternalise</name> <value><string>oui</string></value> </member> <member><name>messageCSRExter</name> <value><string>message pour l'invité</string></value> </member> </struct></value> </member> <member><name>detailsInvitation</name> <value><struct> <member><name>CN</name> <value><string>Nom usuel</string></value> </member> <member><name>Email</name> <value><string>[email protected]</string></value> </member> <member><name>O</name> <value><string>Organisation</string></value> </member> <member><name>STREET1</name> <value><string>adresse</string></value> </member> <member><name>L</name> <value><string>Ville</string></value> </member> <member><name>PostalCode</name> <value><string>12345</string></value> </member> <member><name>ST</name> <value><string>Département</string></value> </member> <member><name>C</name> <value><string>FR</string></value> </member> </struct></value> </member> <member><name>contactAdm</name> <value><struct> <member><name>nomAdm</name> <value><string>Nom</string></value> Page 23 </member> <member><name>prenomAdm</name> <value><string>Prenom</string></value> </member> <member><name>fonctionAdm</name> <value><string>Fonction</string></value> </member> <member><name>telAdm</name> <value><string>+33-1-23-45-67-89</string></value> </member> <member><name>emailAdm</name> <value><string>[email protected]</string></value> </member> </struct></value> </member> <member><name>paiement</name> <value><struct> <member><name>modePaiement</name> <value><string>0vi</string></value> </member> </struct></value> </member> <member><name>divers</name> <value><struct> <member><name>notesClient</name> <value><string>Commande API</string></value> </member> </struct></value> </member> </struct></value> </member> </struct></value> </param> </params> </methodCall> Page 24 Renouvellement (renewing) <?xml version="1.0"?> <methodCall> <methodName>renouvellement</methodName> <params> <param> <value><struct> <member><name>identification</name> <value><struct> <member><name>utilisateur</name> <value><string>nomUtilsateur</string></value> </member> <member><name>motDePasse</name> <value><string>pass</string></value> </member> </struct></value> </member> </struct></value> </param> <param> <value><struct> <member><name>ref demande</name> <value><struct> <member><name>certificat</name> <value><struct> <member><name>refCA</name> <value><string>123456</string></value> </member> <member><name>produit</name> <value><struct> <member><name>code</name> <value><string>X509std</string></value> </member> <member><name>dureeVie</name> <value><int>1</int></value> </member> </struct></value> </member> <member><name>requete</name> <value><struct> <member><name>logiciel</name> <value><string>ModSSL</string></value> </member> <member><name>CSR</name> <value><string>-----BEGIN CERTIFICATE REQUEST----MIIBm... ...Xs -----END CERTIFICATE REQUEST-----</string></value> </member> </struct></value> </member> <member><name>organisation</name> <value><struct> <member><name>siren</name> <value><string>123456789</string></value> </member> <member><name>typeOrg</name> <value><string>FRRCS</string></value> </member> <member><name>nom</name> <value><string>organisation</string></value> </member> <member><name>adresse1</name> <value><string>rue</string></value> </member> <member><name>ville</name> <value><string>ville</string></value> </member> <member><name>codePostal</name> <value><string>12345</string></value> </member> <member><name>pays</name> <value><string>FR</string></value> </member> <member><name>telephone</name> <value><string>+33-1-23-45-67-89</string></value> Page 25 </member> <member><name>codeNaf</name> <value><string>Z722A</string></value> </member> <member><name>numTVA</name> <value><string>FR12123456789</string></value> </member> <member><name>siteWeb</name> <value><string>www.web.com</string></value> </member> </struct></value> </member> <member><name>contactAdm</name> <value><struct> <member><name>nomAdm</name> <value><string>Nom</string></value> </member> <member><name>prenomAdm</name> <value><string>Prenom</string></value> </member> <member><name>fonctionAdm</name> <value><string>Fonction</string></value> </member> <member><name>telAdm</name> <value><string>+33-1-23-45-67-89</string></value> </member> <member><name>emailAdm</name> <value><string>[email protected]</string></value> </member> <member><name>organisation</name> <value><struct> <member><name>paiement</name> <value><struct> <member><name>modePaiement</name> <value><string>pre</string></value> </member> </struct></value> </member> <member><name>divers</name> <value><struct> <member><name>notesClient</name> <value><string>Commande API</string></value> </member> </struct></value> </member> </struct></value> </member> </struct></value> </param> </params> </methodCall> Page 26 Revocation (revocation) <?xml version="1.0"?> <methodCall> <methodName>revocation</methodName> <params> <param> <value><struct> <member><name>identification</name> <value><struct> <member><name>utilisateur</name> <value><string>nomUtilsateur</string></value> </member> <member><name>motDePasse</name> <value><string>pass</string></value> </member> </struct></value> </member> </struct></value> </param> <param> <value><struct> <member><name></name> <value><struct> <member><name>certificat</name> <value><struct> <member><name>refCA</name> <value><string>123456</string></value> </member> </struct></value> </member> <member><name>raison</name> <value><string>raison de revocation</string></value> </member> </struct></value> </member> </struct></value> </param> </params> </methodCall> dcvCodeValidation <?xml version="1.0"?> <methodCall> <methodName>dcvCodeValidation</methodName> <params> <param> <value><struct> <member><name>identification</name> <value><struct> <member><name>utilisateur</name> <value><string>USERNAME</string></value> </member> <member><name>motDePasse</name> <value><string>PASSWORD</string></value> </member> </struct></value> </member> <member><name>refCA</name> <value><string>123456789</string></value> </member> <member><name>dcvCode</name> <value><string>Ld2jwAQQ65uWxvWionINtRBOt35H7nPd</string></value> </member> </struct></value> </param> </params> </methodCall> Page 27 Méthode : statut (status) Parameters identification demande Parameters utilisateur motDePasse Parameters refDemande certificat typeDemande typeReponse statut Descriptions Utilisateur, mot de passe fields For bulk purchases, one request per structure identification Descriptions Username Password demande Descriptions Mandatory for bulk purchases RefTBS, refCA, refClient, nrSerie fields Type 0 : full status 1 : state certificate or/and certificate chain dates validité 2 : état Certificate format X509 => 509 format pkcs7 => pkcs7 format chaine => certification chain Mandatory Yes Yes Type Struct Struct Default Mandatory Yes Yes Type String String Default Mandatory No Yes No Type String Struct Int Default No String x509 Type String String String String Default certificat Parameters Descriptions Mandatory refTBS TBS Reference Optional * refCA CA reference Optional * refClient your reference (as provided in the order) Optional * nrSerie Serial Number Optional * * You need at least 1 out of 4 elements. If you specify more than one, the priority order is: refTBS, refCA, refClient, nrSerie Page 28 0 Response Parameters refDemande codeReponse messageReponse statut produit organisation contactAdm contactTech Descriptions Your reference if it was a bulk order See annex See Annex -3 => Put to sleep -2 => Reissue done -1 => Cancelled 0 => Being processed by the provider, 1 => Valid, 2 => Expired, 3 => Revoked, 7 => on MultiCN Coherence, organisation, telephone, domaine, verifFinale Si typeDemande = 1 ou 0 RefCA, certificat, DateDebut, dateFin Si typeDemande = 0 CodeProduit, logiciel See page 2 See page 2 See page 2 Parameters coherence organisation telephone domaine verifFinale etat (state) Descriptions Coherence: not processed, pending, ok Organization: not processed, pending, ok Phone: not processed, pending, ok Domain: not processed, pending, ok Final Verification: not processed, pending, ok etat certificat Mandatory No Yes Yes Yes Type String Int String Struct Default No Struct No Struct No No No No Struct Struct Struct Struct Mandatory Type String String String String String Default Response if typeDemande = 1 ou 0 certificat Descriptions Parameters refCA dateDebut dateFin detail x509 pkcs7 chaine Mandatory No No No No No No No Type String String String Struct String String String Default CA reference Certificate start date Certificat expiration date Certificate details X509 Certificate (based on typeReponse) PKCS#7 Certificate au (based on typeReponse) Certificate chain (based on typeReponse) Parameters serialNumber Algorithme debut expire CN OU1 OU2 OU3 O STREET1 L ST PostalCode C formatClef lgClef detail Descriptions Certificate serial number Certificate algorithm Certificate start date Certificat expiration date common name/domain name Organizational Unit Organizational Unit Organizational Unit Organization identification number Address Cirty State/Province/Department Postal Code Country (ISO 3166) Private key format (RSA ou ECC) Private key length (bits) Mandatory No No No No No No No No No No No No No No No No Type String String String String String String String String String String String String String String String String Default Response if typeDemande = 0 produit Descriptions Parameters codeProduit logiciel Mandatory No No Type String String Default Product Code Software Code Parameters siren nom adresse organisation Descriptions Organization identification number Legal Name Headquarters Address Mandatory No Yes Yes Type String String String Default Page 29 adresse2 adresse3 ville codePostal pays telephone fax Headquarters Address Headquarters Address Heardquarters' City Headquarters' postal code Country, see annex (iso-3166) Main phone number Main FAX number No No Yes Yes No Yes No String String String String String String String Parameters civiliteAdm nomAdm prenomAdm fonctionAdm telAdm emailAdm contactAdm (administrative contact) Descriptions 0 : M. / 1 : Mrs. / 2 : Miss Lastname Firstname Job Title Direct Phone Number Direct Email Address Mandatory Yes Yes Yes Yes Yes Yes Type String String String String String String Default Parameters civiliteTech nomTech prenomTech fonctionTech telTech emailTech contactTech (Technical Contact) Descriptions 0 : M. / 1 : Mrs. / 2 : Miss Lastname Firstname Job Title Direct Phone Number Direct Email Address Mandatory Yes Yes Yes Yes Yes Yes Type String String String String String String Default Parameters civiliteRespLegal nomRespLegal prenomRespLegal fonctionRespLegal telRespLegal emailRespLegal contactRespLegal Descriptions 0 : M. / 1 : Mrs. / 2 : Miss Lastname Firstname Job Title Direct Phone Number Direct Email Address Mandatory Yes Yes Yes Yes Yes Yes Type String String String String String String Default Page 30 Methode: solde (balance) Parameters identification Parameters utilisateur motDePasse solde Descriptions Utilisateur, mot de passe fields identification Descriptions Username Password Mandatory Yes Type Struct Mandatory Yes Yes Type String String Mandatory Yes Yes Type String Int Response for deposit accounts Parameters date solde Descriptions format : yyyy-mm-jj hh:mm:ss balance Réponse for token/bulk purchase accounts Parameters date soldes Descriptions format : yyyy-mm-jj hh:mm:ss balances : product codes codeProduit (product code) Parameters Descriptions derniereOperation format : yyyy-mm-jj hh:mm:ss nombre amount Page 31 Mandatory Yes Yes Type String Struct Mandatory Yes Yes Type String Int Method: enSommeil (asleep) Parameters identification Parameters utilisateur motDePasse enSommeil Descriptions Utilisateur, mot de passe fields identification Descriptions Username Password Mandatory Yes Type Struct Mandatory Yes Yes Type String String Réponse Parameters ref refCA refCAPrecedent refCASuivant cn lgClef serie logiciel codeProduit nomProduit refTBS dateCreation dateDerniereOperation dateDebut dateExpiration contactTechnique contactAdministratif etat etatControles Commentaires Descriptions Your reference CA reference Previous CA reference Next CA reference Common Name Key length Serial Number Software used Product code Product Name TBS reference (10 numbers) Request creation date Last operation date Certificate Start date Certificate expiration date Technical contact name Administrative Contact name Certificate state (« Mise en sommeil » (asleep)) Checks state Notes Mandatory Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Type String String String String String String String String String String String String String String String String String String Struct String Parameters coherence organisation telephone domaine verifFinale EtatControles (check state) Descriptions Coherence: not processed, pending, OK, non response letter, or legal confirmation Organization: not processed, pending, OK, non response letter, or legal confirmation Phone: not processed, pending, OK, non response letter, or legal confirmation Domain: not processed, pending, OK, non response letter, or legal confirmation Final Verification: not processed, pending, OK, non response letter, or legal confirmation Mandatory No No No No No Type String String String String String Page 32 Method : référence référence Parameters Descriptions identification Utilisateur, mot de passe fields CN Common Name refClient Your reference refCA CA reference nrSerie Serial Number * You need at least 1 out of 4 elements. If you specify more than one, the priority order is: CN, refCA, refClient, nrSerie Parameters utilisateur motDePasse identification Descriptions Username Password Mandatory Yes Optional * Optional * Optional * Optional * Type Struct String String String String Mandatory Yes Yes Type String String Mandatory Yes Yes No Type Int String Struct Mandatory No Yes Yes No No Type String String Int String String Réponse Parameters Descriptions codeReponse See annex messageReponse Number of responses or error messages Reponse Response array Parameters refClient CN refTBS refCA nrSerie Reponse Descriptions Your Reference CN TBS resference (10 numbers) CA reference Serial Number Page 33 Methodes: dcvAdresses Parameters identification CN Parameters utilisateur motDePasse dcvAdresses Descriptions Utilisateur, mot de passe fields CommonName (to be validated via DCV) identification Descriptions Username Password Mandatory Yes Yes Type Struct String Mandatory Yes Yes Type String String Mandatory Yes Yes No Type Int String Struct Mandatory Yes Yes Type String Struct Mandatory Yes Type String Response Parameters Descriptions codeReponse See Annex messageReponse Number of response messages or error messages Reponse Array of responses Parameters type Emails adresses Parameters Email Reponse Descriptions Whois, domain level Array of valid email addresses Emails adresses Descriptions Valid DCV Email Page 34 Statut (status) <?xml version="1.0"?> <methodCall> <methodName>statut</methodName> <params> <param> <value><struct> <member><name>identification</name> <value><struct> <member><name>utilisateur</name> <value><string>nomUtilisateur</string></value> </member> <member><name>motDePasse</name> <value><string>pass</string></value> </member> </struct></value> </member> </struct></value> </param> <param> <value><struct> <member><name>test</name> <value><struct> <member><name>certificat</name> <value><struct> <member><name>refTBS</name> <value><string>1234567890</string></value> </member> </struct></value> </member> <member><name>typeDemande</name> <value><struct> <member><name>type</name> <value><int>0</int></value> </member> </struct></value> </member> <member><name>typeReponse</name> <value><struct> <member><name>format</name> <value><string></string></value> </member> </struct></value> </member> </struct></value> </member> </struct></value> </param> </params> </methodCall> Page 35 Solde (Balance) <?xml version="1.0"?> <methodCall> <methodName>statut</methodName> <params> <param> <value><struct> <member><name>identification</name> <value><struct> <member><name>utilisateur</name> <value><string>nomUtilisateur</string></value> </member> <member><name>motDePasse</name> <value><string>pass</string></value> </member> </struct></value> </param> </params> </methodCall> enSommeil (asleep) <?xml version="1.0"?> <methodCall> <methodName>enSommeil</methodName> <params> <param> <value><struct> <member><name>identification</name> <value><struct> <member><name>utilisateur</name> <value><string>nomUtilisateur</string></value> </member> <member><name>motDePasse</name> <value><string>pass</string></value> </member> </struct></value> </member> </struct></value> </param> </params> </methodCall> Reference <?xml version="1.0"?> <methodCall> <methodName>reference</methodName> <params> <param> <value><struct> <member><name>identification</name> <value><struct> <member><name>utilisateur</name> <value><string>nomUtilisateur</string></value> </member> <member><name>motDePasse</name> <value><string>pass</string></value> </member> </struct></value> </member> </struct></value> </param> <param> <value><struct> <member><name>refClient</name> <value><string>maref</string></value> </member> <member><name>CN</name> <value><string>monsite.com</string></value> </member> <member><name>refCA</name> <value><string>marefCA</string></value> Page 36 </member> <member><name>nrSerie</name> <value><string>numerodeserie</string></value> </member> </struct></value> </param> </params> </methodCall> Page 37 Changelog 2007-07-13 Adding certificate section for renew and reissue Removing fax and organization type on the payment facility (unused) Error message modification (cleartext) Spelling change for some parameters to synchronize with order scripts 2007-08-06 Adding error codes Adding Debit card payment information Adding the product list 2007-08-09 Case parameter correction (camelCase) Manual Formatting 2007-08-28 Status response method Sdding typeReponse to the statut (status) method Status response architecture modification Error codes for reissue and renew + spelling correction Adding reissue reason Adding details about multiCN clonning monoCN 2007-08-29 Adding software codes, organization types, country codes (iso 3166) Adding XML examples V0.1 2007-08-29 2007-09-24 2007-09-27 Rewriting Adding method « revocation » Updating error codes Adding Other software in the software list V0.2 Separating operation and informations on two different API V1.0 2007-10-18 Extending the poduct table Improved URL documentation Moving client-specific information in an external file Adding MSExchange 2007 to the software list 2007-11-01 Adding error coder 8 2008-01-31 Ajout status -2 : reissue finished and -3 : asleep Adding X509Email products (products, SPKAC, software) 2010-01-19 Updating tables TypeOrg et Pays (Country) Adding method « reference » sur api-infos Adding refClient et serial number to call the methode statut (status) 2010-02-08 Adding client certificate order with invitation 2010-05-17 2010-09-09 Removing credit card method (0cb) Adding the method « enSommeil » (aslseep) on api-infos V1.1 2011-04-04 2012-04-19 Adding « Domain Control Validation » DCV on mono-domain certificates « Domain Control Validation » for multi-domain certificates V1.2 2016-02-09 V1.2.1 2016-02-22 Updating products, softwares, parameters. Removing obsolete parameters. Documenting DCV operations. Adding legal representative. English translation. V1.2.2 2016-02-25 Improving status response. Page 38
