The following document explains how to publish a blipp once the SDK has been integrated into an application.
As these are early days for our SDK, we are currently using a temporary publishing flow. Please note that a new publishing flow will be released over the next few months.
This will not affect blipp availability for the custom applications, i.e. blipps will remain available no matter which publishing flow has been used for them.
Currently, blipps are restricted so that they can only run within certain applications:
- Blipps designed to be published in the Blippar app cannot be published in third party apps that use Blippar SDK.
- Blipps designed to be published in a third party app that use the Blippar SDK cannot be published in the Blippar app.
With the introduction of the new publishing flow we will allow the simultaneous blipp publishing in third party apps that use the SDK and in the Blippar app, however even then, the SDK will provide some options for blipp control and communication that will not be possible to implement in the Blippar app. Be aware of this and don't make the blipp available to the Blippar app if it is using specific SDK functionality, such as application and blipp intercommunication, as in these cases the blipp will not be detected by the Blippar app even if it is published.
These blipp availability restrictions are controlled using special Detection Codes. Detection Codes are setup when you create and upload your blipps to the Blippar servers.
The Detection Code is defined as the first 8 characters of your Blippar SDK License-Key that was provided to you when you registered your application with us. For example, if your SDK license key is 24d5019300eda2b722fa3ec21a2b86e2f4f1cb47fd697704f04979db8b2d0d795a99464e then your special unique Detection code is 24d50193.
This detection code is specific to the application tied to this SDK License Key and will not work with any other application you create.
Note the blipp access system is still being finalized and this process will change before the final full release of the SDK.
You do not need to do anything in your application source code to make this detection behaviour work. It is handled automatically using your License Key when you initialise the SDK.
Publishing a Blipp for the SDK
Publishing the blipp for the SDK is performed almost in the same way as if publishing in the Blippar app. There is only one difference in the final step which is described below.
If you have been creating your blipp using Blippbuilder Script (see Blippbuilder Script reference here), you can find a description about the blipp testing and publishing processes in the Blippar Developer Portal documentation.
If you have been using Blippbuilder (see Blippbuilder reference here), you can directly test and publish through the tool. You can find support documentation for Blippbuilder by logging into your Blippar account and checking out the Support Centre.
You can register more than one blipp with the same detection code if you want them all to be visible within your application.
Below we will describe the testing and publishing flow that SDK users should follow.
Modifying the Blipp Detection Code
If you have been using Blippbuilder Script to create your blipp, please follow the blipp publishing documentation up to the last step (stop before pressing the "MAKE IT LIVE" button).
If you have been using Blippbuilder to create your blipp, press the Preview button on the top right hand side of the tool.
From the Test your blipp screen, do not press the "MAKE IT LIVE" button. If you have pressed the button, un-publish the blipp using the Unpublish button and start the publishing process again.
Once you land on the Test your blipp screen, you must set the blipp detection code to be the first 8 characters of your License Key.
Note in the screenshots below, the flow indicates using the Blippar application. This web portal is still under development. Please disregard the Blippar application references. This flow will apply specifically to your own custom application.
Select the current code by double-clicking it:
Enter a new code (ie the first 8 characters of your SDK App Key):
Select OK and wait to see the green check mark (indicates that your new code has been properly processed):
- Press DONE or close the window with the X button.
Congratulations, your new blipp is ready to go. It is now registered against the detection code and will only be visible in your application.
Publishing the Same blipp for Two Target SDK Applications
To publish the same blipp for several target applications user has to list all detection codes (first eight symbols of every license key) in the test code field separated by coma.
For example, lets say the client has two SDK licenses, one for iOS and one for Android:
- iOS SDK License key is "12345678...".
- Android license key is "abcdefgh...".
If the client wants to publish only for iOS, the code in the test field during the publishing should be set to "12345678".
To publish the blipp for both target platforms the code should be set to: "12345678, abcdefgh".
You only need to create a copy of the blipp if you want it to be available in both Blippar app and your custom application. See the chapter "Publishing the Same Blipp for the SDK and Blippar app" for the detailed instruction abot this.
Publishing the Same Blipp for the SDK and Blippar app
Due to the fact that the blipp has to be published in the test mode for the custom application it will not be available to Blippar application users unless they enter the same test code in the Blippar application (look for the "Enter a code" button in settings).
To be able to see the blipp both in the Blippar application and in your custom application you will have to create two copies of the same blipp. Here is how:
- Open the list of your blipps.
- Instead of opening the blipp you want to copy in Blippbuilder or uploading a new script in Blippbuilder Script, find the three dots next to the blipp name and click on them.
- Choose to view version history.
- A timeline with all blipp versions will be shown. Scroll to the top (latest) blipp version.
- Find the "Download blipp data" button just below the blipp marker images (on the right hand side of the screen).
- Click it to download a zip with raw blipp data.
- Create a new blipp and select to upload a script in Blippbuilder Script instead of creating a new blipp in Blippbuilder.
- Enter the blipp name and add blipp markers.
- On the next screen when asked to upload the blipp source data select to upload the archive you have just downloaded (see step 6).
- Wait for the upload to complete.
- Select to test the blipp and enter first eight SDK license symbols as a test code.
- Try scanning it with the SDK activity in your custom application.