User manual - Trademark Clearinghouse
Contents
1. API Operational Test and Evaluation Platform API OT amp E platform User manual AUGUST 28TH 2013 a CLEARINGHOUSE AY 0 N INTRODUCTION 3 ii Overview of the API OT amp E platform 3 12 The intended audience for this document 3 13 User manual overview 3 14 Referenced documents 4 THE API OT amp E PLATFORM 5 2 1 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 3 2 Performing the test 7 APPENDIX 10 ai Frequently asked questions 10 42 Glossary 11 ADMINISTRATIVE INFORMATION 12 5 1 Document information 12 52 Changes 12 API OT amp E PLATFORM USER MANUAL VERSION 1 3 AUGUST 28TH 2013 o gt CLEARINGHOUSE 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 project2. This is only possible for marks with an INCORRECT status 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 a10 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 AUTOMATED STATUS CHANGE STATUS CHANGE siete 10 min delay 10 min delay AUTOMATED STATUS CHANGE aaan 10 min delay Figure 5 The flow of different test scenarios for POU files API OT amp E PLATFORM USER MANUAL VERSION 1 3 AUGUST 28TH 2013 o gt CLEARINGHOUSE 3 2 4 Test scenario 4 The Proof of U
3. 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 created 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 1 3 AUGUST 28TH 2013 3 CLEARINGHOUSE OM 1 4 Refer
4. 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 If 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 1 3 AUGUST 28TH 2013 oe CLEARINGHOUSE 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 omit ted The API OT amp E platform is intended to exchange data with another automated sys tem 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 eSB MAB Clearinghouse If you are interested in protecting your brand in the New gTLD era please register as trademark ho
5. aluation Platform API OT amp E platform IBM GTS Deloitte Wouter Schenk 28 08 2013 Official version 1 3 Version Date Author Summary changes 0 1 30 06 2013 Wouter Schenk Initial version 0 2 01 07 2013 Wouter Schenk Small changes after informal review 0 3 02 07 2013 JP Roulleaux Review and comments 0 4 02 07 2013 Earl Stroex Carr Review amp proof read 0 5 03 07 2013 Wouter Schenk Several changes after review amp latest screens 1 0 04 07 2013 Wouter Schenk Several changes after review Deloitte 1 1 11 07 2013 Wouter Schenk Several changes after comments Deloitte 1 2 15 07 2013 Wouter Schenk Several changes after review 1 3 28 07 2013 Wouter Schenk Additional tests described API OT amp E PLATFORM USER MANUAL VERSION 1 3 AUGUST 28TH 2013 ka
6. d in as a default value A password for this connection to be entered twice My account Edit current API settings IPv4 address to access API 195 212 29 92 API password Retype password 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 data base To create a new session 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 Au tomated interface manual 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 data exchange with the TMCH test database uses XML formats as described in the Clearinghouse TMCH Automated interface manual The necessary API com mands used are similar to the ones described in the Clearinghouse TMCH Automated interface manual API OT amp E PLATFORM USER MANUAL VERSION 1 3 AUGUST 28TH 2013 CLEARINGHOUSE AA 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 acc
7. e accessed via https ote agents trademark dearinghouse com The OTSE API Interface can be accessed via 91 198 00 0 7700 using TCP TLS Your credentials to access the OT amp E environment are e Username lt tmpl_var name userid gt e Password lt tmpl_var name password gt Please note that this is a test platform for which we e do not provide a warranty on the security layer e strongly recommend the use of dummy data only e 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 dearinghouse 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 Please do not reply to this e mail address If you should have any queries then please submit your questions through the ticketing system available on the Clearinghouse User Interface This is an authentic e mail notification from the Clearinghouse Verification Provider a part of the Trademark Clearinghouse the central repository for verified brands for the purpose of protecting brands in ICANN s new gTLD program Figure 1 Example of a test account sent by email The test username is derived from the existing username The u prefix of the
8. enced documents The following documents are referenced in this user manual Refnr Document Version Datum Auteur 1 TMCH Automated interface API 1 1 3 25 04 2013 J Jansen 2 TMCH functional specifications 5 16 04 2013 G Lozano B Hoeneisen 3 Sunrise and Claim processes 1 2 29 04 2013 j L Defay functional analysis 3 TMCH Sunrise amp Claims 0 13 23 05 2013 J W Fonk Architecture API OT amp E PLATFORM USER MANUAL VERSION 1 3 AUGUST 28TH 2013 4 oa CLEARINGHOUSE 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 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 process you are now also granted access to the OTRE API environment The OT amp E Web interface can b
9. lder or trademark agent Upon a successful registration you vill be able to submit your trademark records and be eligible for trademark claims notification and or sunrise services For more information about the Trademark Clearinghouse please go to All related documents FAQ and how to s are made available on ynew trademark clearinghouse com 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 1 3 AUGUST 28TH 2013 ka eo CLEARINGHOUSE 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 page via my account gt API settings Here you can configure your connection to exchange information 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 fille
10. ording 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 Proof Of Use POU files belonging to a specific mark name with a filename containing the 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 string INCORRECT are processed according to test scenario 4 described in paragraph 3 2 5 Proof Of Use POU files belonging to a specific mark name with a filename containing the string INVALID are processed according to test scenario 4 described in paragraph 3 2 6 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 AUTOMATED AUTOMATED AUTOMATED STATUS CHANGE i Jede i i STATUS CHANGE 10min delay fo ee 10 min delay ff enn 10 min delay markname set on INCORRECT naonn 10 min delay Figure 4 The flow of different test
11. s 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 API OT amp E PLATFORM USER MANUAL VERSION 1 3 AUGUST 28TH 2013 Pa CLEARINGHOUSE 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 l 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 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 use 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 bet
12. scenarios 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 API OT amp E PLATFORM USER MANUAL VERSION 1 3 AUGUST 28TH 2013 oa CLEARINGHOUSE 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 a10 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
13. se file is valid In order to test the process of a correct POU file 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 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 ainvalid 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 statu
14. the Public Key Infrastructure PKI Top Level Domain Trademark Clearing House is an ICANN central repository for information to be authenticated stored 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 1 3 AUGUST 28TH 2013 aa CLEARINGHOUSE oM 5 ADMINISTRATIVE INFORMATION 5 1 Document information Subject Client Author Date Status Version API Operational Test and Ev
15. ween the two platforms API OT amp E PLATFORM USER MANUAL VERSION 1 3 AUGUST 28TH 2013 Ba CLEARINGHOUSE O 4 2 Glossary Term 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 Description 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
Download Pdf Manuals
Related Search