/v2/portal

Reserved

The portal resource is currently reserved for internal use only.

To authenticate with your portal credentials, please see the authenticate resource.

GET

Parameter Options
token for portal with admin authorization
id The Portal ID

Usage

Portals require admin authorization by Rumblefish to access reserved resources.

Without a specified :id, a GET returns a JSON blob of all of the Portals in the system. No nil values.

    {
      "portals"=>
      [
        {
          "id"=>1536, 
          "public_key"=>"test30375", 
          "receipt_value"=>false, 
          "receipt_subject"=>"Your Licenses!", 
          "invoicing"=>false, 
          "admin"=>true
        },
        {
        ......
        },
        {
          "id" => 99 
          "public_key" => "Mom's Deli",
          "logo_url" => "http://images.moms.com/",
          "receipt_header_text" => "Thanks for the Money",
          "receipt_footer_text" => "Please don't call us" ,
          "billing_name" => "Ebenezer Scrooge",
          "billing_email" => "scooge@me.com",
          "billing_phone" => "503-222-4455string",
          "billing_address1" => "107 SE Washington",
          "billing_address2" => "self.billing_address2",
          "billing_city" => "Portland",
          "billing_state" => "Oregon",
          "billing_country" => "USA",
          "billing_postal" => "99999STRING",
          "contact_name" => "EbenezerS",
          "contact_email" => "scooge@me.com",
          "contact_phone" => "503-222-4455string",
          "receipt_value" => false,
          "receipt_subject" => "Receipt if you got one",
          "invoicing" => false,
          "rate_card" => nil, #actually API won't deliver a nil
          "rate_card_description" => "self.rate_card_description",
          "admin" => false
         }
        ]
      }
  

With an :id, GET provides the details for that particular Portal. Additionally, it provides the Licenses and Catalogs attached to that particular Portal.

    {
      "portal"=>
      {
        "id"=>1525, 
        "public_key"=>"test30356", 
        "receipt_value"=>false, 
        "receipt_subject"=>"Your Licenses!", 
        "invoicing"=>false, 
        "admin"=>true
      }, 
      "portal_licenses"=>
      [
        {
          "id"=>78, 
          "license_id"=>297, 
          "download"=>true, 
          "price"=>"1.99"
        }
      ], 
      "portal_catalogs"=>
      [
        {
          "id"=>178, 
          "catalog"=>
          {
            "id"=>947, 
            "name"=>"Test Catalog"
          }
        }
      ]
    }
  

PUT

Parameter Options
token
id The Portal ID
public_key This is the login name for portal connections (no spaces by convention)
password The api does not validate password construction
logo_url Logo is used on the HTML email receipt
receipt_header_text Opening text that precedes the invoice portion of the receipt. Greetings and thank you's go here
receipt_footer_text Closing text added to the foot of the receipt form (usually for customer service info)
billing_name
billing_email api does not validate this string
billing_phone
billing_address1
billing_address2
billing_city
billing_state
billing_country
billing_postal A string may contain alpha and numeric
contact_name
contact_email api does not validate this string
contact_phone
receipt_value :boolean true means this portal emails receipts from transactions
receipt_subject This is the subject line text for receipt emails
invoicing :boolean true means this portal allows invoicing
rate_card XML file describing the pricing and terms of all B to B licenses
rate_card_description Short description of the kind of rate card
admin :boolean true means this portal is another Backstage and can administer portals

Usage

This is used for updating data in an existing portal record. Since the item already exists, the only required fields are the ID and Token.

A successful PUT returns the individual Portal data blob as JSON.

POST

Parameter Options
token
public_key This is the login name for portal connections (no spaces by convention)
password The api does not validate password construction
All Other parameters listed in PUT are optional for POST

Usage

The successful completion of a PORTAL creation returns a small JSON with :portal_id => ID#