Please enter new password for:
 
 
 

Segoma Developer REST API


Thank you for using Segoma's 3D Image service!
In this page you will find information regrading the Segoma REST API.
For further assistance please refer to our Contact page.



3D Image reference code
Client reference code
Fetching 3D Image reference code by Lot Number
 



3D Image reference code


The 3D Image reference code is a unique identifier for your image and it is needed for the 3D
Image player to view a specific image. In order to obtain the 3D Image reference code according
to its Lot Number please access your account on Segoma.com and use the CSV download utility.
The reference code is composed of 10 alphanumeric letters, e.g. "8WNVR89DZZ". For more
information about the 3D Image reference code, please refer to:
How can I send someone else a link to my 3D Image?  



Client reference code


As a client of Segoma you have a reference code to uniquely identify you when using our REST API.
This reference code is useful for developers who want to interface with the Segoma API in order to
obtain some 3D Image reference codes according to their Lot Numbers and also for other operations.
The Client reference code is a secret phrase which should not be handed over to 3rd party developers.
For non-developer ways to obtain a 3D Image reference code for a specific image, please refer to:
How can I send someone else a link to my 3D Image?  




Description Fetching 3D Image reference code by Lot Number
URI https://segoma.com/WebService/photo/getPhotoRef
GET Request

/WebService/photo/getPhotoRef/{clientRefCode}/{clientLot}

Parameter Description
clientRefCode Client Reference Code
clientLot Lot Number

Example

/WebService/photo/getPhotoRef/NVZFZ82YVV/AL-1443
Response

{photoRefCode}

Example

OIJLNLT5WW
POST Request

/WebService/photo/getPhotoRef

Parameter Description
clientRefCode Client Reference Code
clientLot Lot Number

Multiple values of Lot Number can be separated by ","
Response Formatted in json:

[
  ["{clientLot}", "{photoRefCode}"],
	...
]

Example

[
  ["AL-1443","OIJLNLT5WW"],
  ["AL-1447","MIT1LNANYY"],
  ["100852","NOG6RDFN77"]
]
Example with an HTML FORM tag

<form action="https://segoma.com/WebService/photo/getPhotoRef/" method="post">
	<input type="hidden" name="clientRefCode" value="NVZFZ82YVV">
	<input type="hidden" name="clientLot" value="111109,111404,113105">
	<input type="submit" value="Submit">
</form>