API OT&E platform User manual v2.0
Contents
1. API API OT amp E platform CRL DN DNS DNL IDN Label SMD SMD File SMDM Manager SMD Revocation List TLD TMCH TMH TMV Mark Trademark POU PRM Application Programming Interface An application programming interface API that specifies how software components interact with each other In practice an API is a library that usually includes specification for routines data structures object classes and variables A test platform to test the TMCH API without the risk of disturbance on the production platform Certificate Revocation List Domain Name Domain Name System Domain Name Label Internationalized Domain Names The domain name without its TLD extension Signed Mark Data A cryptographically signed token issued by the TMV to the TMH to be used in the Sunrise Period in order to apply for a domain name that matches a DNL of a PRM A file containing the SMD see above and includes readable data The latter is usually ignored in the processing of the SMD File An entity managing the SMD s mainly maintaining lists of revoked SMD s The SMD revocation list is used by registries and optionally by registrars during the Sunrise Period to ensure that an SMD is still valid i e not revoked The SMD revocation list has a similar function as CRL s used in the Public Key Infrastructure PKI Top Level Domain Trademark Clearing House is an ICANN central repository for information to be authenticated st2. API Operational Test and Evaluation Platform API OT amp E platform User manual 22 NOVEMBER 2013 CLEARINGHOUSE e AY O 0 INTRODUCTION 3 11 Overview of the API OT amp E platform 3 12 The intended audience for this document 3 13 User manual overview 3 1 4 Referenced documents 4 THE API OT amp E PLATFORM 5 21 Logging on to the API OT amp E platform 5 22 Differences with the production platform 6 TESTING USING THE API OT amp E PLATFORM 7 3 1 Configuring the connections 7 232 Performing the test 7 APPENDIX 14 4 Frequently asked questions 14 42 Glossary 15 ADMINISTRATIVE INFORMATION 16 51 Document information 16 52 Changes 16 API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 Ea CLEARINGHOUSE e 1 INTRODUCTION This User Manual contains all essential information for the user to make full use of the API Operational Test and Evaluation Platform API OT amp E platform This manual includes a descrip tion of the platform its functions capabilities and step by step procedures for conducting a test for the API 1 1 Overview of the API OT amp E platform The Trademark Clearinghouse is a global repository for trademark data designed to meet global needs for the domain name system DNS the Trademark Clearinghouse Verifies trademark data from multiple global regions Maintains the verified trademark record database The TMCH project
3. 4 Referenced documents The following documents are referenced in this user manual Refnr Document Version Datum Auteur TMCH Automated interface API 1 3 25 04 2013 J Jansen 2 TMCH functional specifications 16 04 2013 G Lozano B Hoeneisen 3 Sunrise and Claim processes 29 04 2013 j L Defay functional analysis TMCH API Command Reference for API v2 Automated Interface XSD Scheme for API v2 4 TMCH Sunrise amp Claims 0 13 Architecture API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 ES CLEARINGHOUSE o gt 2 THE API OT amp E PLATFORM This chapter provides a general overview of the web based API OT amp E platform It explains how to gain access to the platform and how the platform differs from the production platform 2 1 Logging on to the API OT amp E platform The API OT amp E web platform can be reached by the following URL or IP addresses APP 91 198 126 137 or https ote agents trademark clearinghouse com API 91 198 126 138 port 7700 with TLS API v2 91 198 126 138 port 7701 with TLS All validated agents will receive an API OT amp E web platform test account by email The API OT amp E platform does not have the option for additional users to register Test users are generated automatically Subject OT amp E Agent Registration process Your sign in details Dear lt tmpl_var name name gt Thank you for completing the Trademark Agent registration
4. MANUAL VERSION 2 0 22 11 2013 CLEARINGHOUSE oe Once the update is completed successfully after a 10 minute delay the mark will be processed and you may check the status again by reading the messages received via the poll message When the mark is correct and approved the mark name is set to VERIFIED in the TMCH test database All API commands mentioned above are described in the Clearinghouse TMCH Automated interface manual 3 2 3 Test scenario 3 The mark is invalid In order to test the process of an invalid mark being rejected you can enter a mark into the API with a label containing the string INVALID After a 10 minute delay the mark will be processed and you may check the status by reading the messages received via the poll message and verify whether the mark has been approved In case of an invalid mark the mark will not be approved and the name is set to INVALID in the TMCH test database Also if you submit one or multiple POU files for an invalid mark no POU file will be validated Test scenario 4 Test scenario 5 Test scenario 6 AUTOMATED STATUS CHANGE sani ui STATUS CHANGE 10 min delay pee lOmindelay p 10 min delay POU file set on INCORRECT Figure 5 The flow of different test scenarios for POU files POU file set on INVALID 3 2 4 Test scenario 4 The Proof of Use file is valid In order to test the process of a correct POU fil
5. created an automated interface to allow users to interact with the data stored in the Clearinghouse database TMCH database This automated interface API has been cre ated to exchange data with the TMCH database The API OT amp E platform is a test platform to test the API without the risk of disturbing the production platform 1 2 The intended audience for this document This user manual is intended for users that are involved in the mark registration processes These users are trademark agents that have a contract with the Clearinghouse and have been provided access to the automated interface API for their data exchange It is assumed that the users are already familiar with the current API production environment This manual will therefore focus on the differences between the production environment and the test environment 1 3 User manual overview This manual contains the following chapters Chapter 1 Introduction to the TMCH database the related API the API OT amp E platform and its users Chapter 2 General overview of the web based API OT amp E platform Chapter 3 Explanation of how to set up an API test Chapter 4 Further background and reference information Please note that the project is still under development and thus subject to change The screens described in this document may vary from the actual final screens API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 e CLEARINGHOUSE 1
6. process you are now also granted access to the OT amp E API environment The OT amp E Web interface can be accessed via https ote agents trademark clearinghouse com The OT amp E API Interface can be accessed via 91 198 xxx xxx 7700 using TCP TLS The new OT amp E API version 2 available since 15th of November 2013 can be accessed via 91 198 50xx200c 7701 using TCP TLS Your credentials to access the OT amp E environment are Username tmpl var name userid gt Password tmpl var name password gt Please note that this is a test platform for which we do not provide a warranty on the security layer strongly recommend the use of dummy data only do not provide a data migration path to production do not guarantee error or bug free operations Additional information regarding the OT amp E environment can be found on our website trademark clearinghouse com in the help download section Please use the ticketing system available on the Clearinghouse User Interface to submit any issues or questions We look forward to receiving your comments We thank you for your trust The Clearinghouse Figure 1 Example of a test account sent by email The test username is derived from the existing username The u prefix of the existing user name is replaced by t prefix in the test username The generated password is fixed and cannot be changed The change password link is omitted on the API OT amp E platform I
7. test scenarios for marks 3 2 1 Test scenario 1 The mark has been verified In order to test the process of a correct mark being accepted you can enter a mark into the API with a label containing the string VERIFIED After a 10 minute delay the mark will be processed and you may check the status by reading the messages received via the poll message and verify whether the mark has been approved When the mark has been approved the mark name is set to VERIFIED in the TMCH test database 3 2 2 Test scenario 2 The mark needs to be corrected In order to test the process of an incorrect mark being rejected you can enter a mark into the API with a label containing the string INCORRECT After a 10 minute delay the mark will be processed and you may check the status by reading the messages received via the poll message in order to verify whether the mark has been ap proved In case of an incorrect mark when the mark is not approved the mark name is set to INCORRECT in the TMCH test database When a mark has not been approved you can undertake the following steps In order to find out the reason generate the info command allowing you to see your mark data including the validator s comments which should guide you to make the corrections in the production platform You can correct the mark by issuing the API update command This is only possible for marks with an INCORRECT status API OT amp E PLATFORM USER
8. 1 1 1 2 1 3 2 0 30 06 2013 01 07 2013 02 07 2013 02 07 2013 03 07 2013 04 07 2013 11 07 2013 15 07 2013 28 07 2013 22 11 2013 Author Wouter Schenk Wouter Schenk JP Roulleaux Earl Stroex Carr Wouter Schenk Wouter Schenk Wouter Schenk Wouter Schenk Wouter Schenk Joris Goiris Summary changes Initial version Small changes after informal review Review and comments Review amp proof read Several changes after review amp latest screens Several changes after review Deloitte Several changes after comments Deloitte Several changes after review Additional tests described Complemented the document with API 2 information API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 LE
9. API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 B Test Scenario 10 CORRECTED Case Figure 4 The flow for a corrected court case where REFNUM is set to VALID API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 LH CLEARINGHOUSE e 4 APPENDIX This section contains additional background and reference information 4 1 Frequently asked questions The most requested questions regarding the API OT amp E platform QUESTION Do need to register for a test account ANSWER No Verified Agents in TMCH will automatically receive a test account to access the API OT amp E platform QUESTION Ihave lost my password for my test account how can I retrieve it ANSWER The change password button is omitted in the API OT amp E platform You can retrieve your password by raising an incident via the production platform QUESTION Can luse the same machine IP address to access the test environment and the pro duction environment ANSWER Yes This IP address is then registered as a safe IP address to which both the API OT amp E platform and the TMCH production platform may communicate QUESTION Can l import into the TMCH production platform the data have generated while doing tests in the API OT amp E platform ANSWER No there is no link between the two platforms API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 LU CLEARINGHOUSE 4 2 Glossary Description
10. D are processed according to test scenario 6 described in paragraph 3 2 6 UDRP and court case functionality is available via the API v2 UDRP cases containing string VALID in CASENO or in REFNUM for court cases are pro cessed according to test scenario 7 described in paragraph 3 2 7 UDRP cases containing string INVALID in CASENO or in REFNUM for court cases are pro cessed according to test scenario 8 described in paragraph 3 2 8 UDRP cases containing string INCORRECT in CASENO or in REFNUM for court cases are processed according to test scenario 9 described in paragraph 3 2 9 UDRP cases or court cases being corrected are processed according to test scenario 10 described in paragraph 3 2 10 API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 R CLEARTNGHOUSE ea Marks that have no labels that contain the strings VERIFIED INCORRECT or INVALID will be processed as VERIFIED according to test scenario 1 POU files that have filenames that do not contain the strings VALID INCORRECT or INVALID will be processed as VERIFIED according to test scenario 4 Test scenario 1 Test scenario 2 Test scenario 3 Rari Hed PTT HANGE STATUS CHANGE 10 min delay enn lOmindelay nee nnn 10 min delay markname set on INCORRECT AUTOMATED STATUS CHANGE markname AUTOMATED STATUS CHANGE m 10 min delay Figure 4 The flow of different
11. e being accepted you can enter a POU into the API with filename containing the string VALID After a 10 minute delay the POU file will be processed and you may check it s status by reading the messages received via the poll message and verify whether the POU file has been approved When the POU file has been approved the POU is set to VALID in the TMCH test database If you submit multiple POU files for a specific mark only the last file is validated 3 2 5 Test scenario 5 The Proof of Use file is incorrect In order to test the process of a correct POU file being rejected you can enter a POU into the API with filename containing the string INCORRECT After a 10 minute delay the POU file will be processed and you may check it s status by reading the messages received via the poll message and verify whether the POU file has been approved In case of an incorrect POU file the POU file will not be approved and the POU is set to INCOR API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 LU CLEARINGHOUSE e RECT in the TMCH test database If you submit multiple POU files for a specific mark only the last file is validated 3 2 6 Test scenario 6 The Proof of Use file is invalid In order to test the process of a invalid POU file being rejected you can enter a POU into the API with filename containing the string INVALID After a 10 minute delay the POU file will be processed and you may check it s sta
12. e containing the string INVALID API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 m CLEARINGHOUSE e 10 min delay Figure 2 The flow for an invalid court case 3 2 9 Test scenario 9 case is incorrect In order to test the process of an incorrect court case you can enter a court case with the API v2 with REFNUM containing the string INCORRECT After a10 minute delay the court case will be processed and you may check the case status by using the API v2 info command Labels will not be updated UDRP cases are treated in the same way based on the CASENO value containing the string INCORRECT 10 min delay Figure 3 The flow for an incorrect court case 3 2 10 Test scenario 10 case is corrected For a corrected case different options are possible Figure 9 shows the example where you set the status to VALID by adding the string VALID to the REFNUM Associated labels will get their desired status using the chosen string VALID INVALID INCORRECT or CORRECTED Next to VALID you can set a corrected case to INVALID or INCORRECT After a 10 minute delay the court case and associated labels will be processed and you may check the case status and label statuses by using the API v2 info command UDRP cases are processed similarly based on the CASENO value containing the string VALID INVALID or INCORRECT
13. f any support is required regarding the access to the API OT amp E platform it must be made via the production platform API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 na CLEARINGHOUSE o gt 2 2 Differences with the production platform The new API OT amp E platform differs from the production platform in appearance and functionality To avoid users mistaking the test environment for the production environment warnings and different colours are used to indicate that they are not in the production platform The API OT amp E web platform has limited functionality Incidents cannot be raised on the API OT amp E platform A request for support must be made on the production platform No registration is available via the web interface The register button is omitted No change password functionality is available The change password button is omitted The API OT amp E platform is intended to exchange data with another automated system Manually uploading data using the web client is not supported The color red and warnings indicate that this is a test platform Welcome to the Trademark Clearinghouse OT amp E Environment If you are interested in protecting your brand in the Nev gTLD era please register as trademark holder or trademark agent Upon a successful registration you v ll be able to subenit your trademark records and be eligible for trademark claims notification and or sunrise services For mo
14. ge with the TMCH test database uses XML formats as described in the Clearinghouse TMCH Automated interface manual The necessary API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 CLFARINGHOUSF e API commands used are similar to the ones described in the Clearinghouse TMCH Automated interface manual For testing with API v2 we refer to the related TMCH API Command Reference Various tests have been designed in order to test the connections with the API OT amp E All trade marks will be accepted and processed The domain convention will determine how the marks are processed Three scenarios are possible Mark names containing the string VERIFIED are processed according to test scenario 1 described in paragraph 3 2 1 Mark names containing the string INCORRECT are processed according to test scenario 2 described in paragraph 3 2 2 Mark names containing the string INVALID are processed according to test scenario 3 described in paragraph 3 2 3 string VALID are processed according to test scenario 4 described in paragraph 3 2 4 Proof Of Use POU files belonging to a specific mark name with a filename containing the Proof Of Use POU files belonging to a specific mark name with a filename containing the string INCORRECT are processed according to test scenario 5 described in paragraph 3 2 5 Proof Of Use POU files belonging to a specific mark name with a filename containing the string INVALI
15. ored and disseminated pertaining to the rights of trademark holders Trademark Holder The person or organization owning rights on a Trademark TMV Trademark Validator Trademark validation organization is an entity authorized by ICANN to authenticate and validate registrations of trademarks registered trademarks court validated marks or marks that are protected by statute or treaty for protection during sunrise and claim period This organization also ensures that proof of mark usage is provided which can be demonstrated by furnishing a signed declaration and a current example of trade mark usage Marks trademarks are used to claim exclusive property rights of products and or services A mark is typically a name word phrase logo symbol design image or a combination of these elements Registered Trademarks Court Validated Marks Marks are protected by statute or treaty Proof Of Use A file that contains evidence of ownership of a mark name These files may be in PDF or JPG format Pre registered mark Mark that has been pre registered with the TMCH API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 CLEARINGHOUSE oM 5 ADMINISTRATIVE INFORMATION 5 1 Document information Subject Client Author Date Status Version API Operational Test and Evaluation Platform API OT amp E platform IBM GTS Deloitte Wouter Schenk November 2013 Official version 2 0 Version Date 0 1 0 2 0 3 0 4 0 5 1 0
16. page via my account gt API settings Here you can configure your connection to exchange informa tion with the TMCH test database through the test API On the API settings screen you can configure your connections with the TMCH test database Several values are required to configure the connection An IP address to access API This IP address is then registered as a safe IP address to which the TMCH test database will communicate The IP address which you configure is filled in as a default value A password for this connection to be entered twice My account Edit current API settings 195 212 29 92 Figure 3 Snapshot of the API settings screen for configuring the API connection Once your connection has been configured you can create sessions with the TMCH test database To create a new session with the API vi you can use API commands described in the Clearinghouse TMCH Automated interface manual such as PP login PP logout PP hello to keep the session alive Specific information about these API commands can be found in the Clearinghouse TMCH Automated interface manual To create a new session with the API v2 available on OT amp E since November 15th 2013 you can use the API commands described in the TMCH API Command Reference 3 2 Performing the test Once the connection has been configured users can execute the test by entering trademarks marks into the API OT amp E The API v1 data exchan
17. re information about the Trademark Clearinghouse please go to vany trademark clearinghouse com All related documents FAQ and how to s are made available on van trademark clearinghouse com COOKIE NOTICE B PRIVACY STATEMENT um il CORN INQUIRES MORE INFORMATION Welcome to the Trademark Clearinghouse If you are interested in protecting your brand in the New gTLD era please register as trademark holder or trademark agent Upon a successful registration you will be able to submit your trademark records and be eligible for trademark claims notification and or sunrise services e Trademark Clearinghouse please go to se com All related documents FAQ and how to s are made available on www trademark clearinghouse corn COGMIE NOTICE A PRIVACY STATEMENT QUISCLAIMER ERA NRS ORL POPMA ION The verification web platform has less functionality Figure 2 Differences between the production and API OT amp E platform API OT amp E PLATFORM USER MANUAL VERSION 2 0 22 11 2013 e CLEARINGHOUSF o gt 3 TESTING USING THE API OT amp E PLATFORM This chapter describes the step by step procedures for conducting API tests These procedures can be divided in the following generic steps 1 Configuring the connections 2 Performing the test 3 Test validation 3 1 Configuring the connections After you are logged on to the API OT amp E platform you can navigate to the API settings
18. tus by reading the messages received via the poll message and verify whether the POU file has been approved When the POU file has been approved the POU file will not be approved and the POU is set to INVALID in the TMCH test database If you submit multiple POU files for a specific mark only the last file is validated 3 2 7 Test scenario 7 case is valid In order to test the process of a valid court case you can enter a court case with the API v2 with REFNUM containing the string VALID and providing in the associated labels the desired status string VALID INVALID INCORRECT or CORRECTED After a 10 minute delay the court case and associated labels will be processed and you may check the case status and label statuses by using the API v2 info command UDRP cases are processed similarly based on the CASENO value containing the string VALID label contains incorrect label status corrected Figure The flow for a valid court case 3 2 8 Test scenario 8 case is invalid In order to test the process of an invalid court case you can enter a court case with the API v2 with REFNUM containing the string INVALID After a 10 minute delay the court case and associated labels will be processed and you may check the case status and label statuses by using the API v2 info command All labels are set to INVALID UDRP cases are processed similarly based on the CASENO valu
Download Pdf Manuals
Related Search