View
 

Frequently Asked Questions

Page history last edited by David Sifry 1 year, 7 months ago

General Questions 

  • Q: What is this? Why am I here?
  • Q: What is an API?
    • A: The Reseller API is a RESTful webservice that speaks in XML and JSON over HTTP. Check out Wikipedia for a more in-depth explanation about APIs.
  • Q: Do I need to be a programmer to work with the Offbeat Guides Reseller API?
    • A: You probably should be a programmer. While we're trying to make this as easy as possible, working with our (or any) API does require engineering knowledge and experience. If you're interested in integrating the Reseller API into your website and have more questions, please contact us at api-help@offbeatguides.com.
  • Q: What does the API allow me to do?
    • A: The API allows you to do nearly everything we do on www.offbeatguides.com but without sending your customers to our website. See more of the API on the reference page.
  • Q: What language does my website or application need to be written in in order to use the API?
    • It doesn't matter as long as your language can speak in XML and JSON over HTTP. We're using a RESTful interface so it should be pretty easy.
  • Q: Does it matter what kind of hosting I have?
    • Nope. Just make sure you can make requests to other servers from your hosting facility (which, you likely can.)
  • Q: Help! I have technical questions that are not answered here.
  • Q: Help! I have non-technical questions that are not answered here.

 

A bit more technical questions 

  • Q: What types of shipping are available?
    • Version 1.5 of our API currently only allows for the creation of PDF guides, so there's no need to use traditional shipping.
  • Q: Will I receive a tracking number when I an order is placed?
    • A: Yes, once the order has been placed, your customer will optionally get an email notification of the order and when the PDF is ready, and you will have an Order ID that you can use to check on the status of the order, as well as get the PDF for delivery to your customer.
  • Q: What type of authentication is required?
    • A: It's pretty simple. You'll get an authentication token that you will use to validate your orders as part of the API.
  • Q: You've completely missed my question here.
    • A: Oops. This is still a work in progress. Send us an email at api-help@offbeatguides.com and we'll update you and our documentation.

Comments (0)

You don't have permission to comment on this page.