shlinkio / shlink-importer
Collection of tools to import links from different sources and map them to a shlink-compliant format
Installs: 33 912
Dependents: 1
Suggesters: 0
Security: 0
Stars: 4
Watchers: 3
Forks: 2
Open Issues: 3
Requires
- php: ^8.2
- ext-json: *
- laminas/laminas-servicemanager: ^3.22
- league/csv: ^9.14
- shlinkio/shlink-config: ^3.0 || ^2.5
- shlinkio/shlink-json: ^1.0
- symfony/console: ^7.0 || ^6.4
Requires (Dev)
- guzzlehttp/guzzle: ^7.8
- phpstan/phpstan: ^1.10
- phpstan/phpstan-phpunit: ^1.3
- phpunit/phpunit: ^11.0
- psr/http-factory: ^1.0
- roave/security-advisories: dev-master
- shlinkio/php-coding-standard: ~2.3.0
- symfony/var-dumper: ^7.0 || ^6.4
Suggests
- psr/http-client: If you want to be able to import URLs from Bit.ly, YOURLS, Kutt.it or another Shlink instance
- psr/http-factory: If you want to be able to import URLs from Bit.ly, YOURLS, Kutt.it or another Shlink instance
README
Collection of tools to import links from different sources and map them to a shlink-compliant format.
Installation
This module can be installed using composer:
composer require shlinkio/shlink-importer
Supported import sources
Bit.ly
It imports using the API v4. The only required param is an access token.
Only the URLs will be imported. Visits/clicks won't be imported yet (See #20).
YOURLS
It imports using YOURLS API. However, since it has some missing capabilities, it requires a dedicated plugin to be installed in YOURLS.
The plugin covers the missing actions in the API, which allow Shlink to list the URLs and all their visits.
It will import short URLs and all their visits, but any information that YOURLS does not track (like the geolocation) cannot be obtained.
Kutt.it
It imports using Kutt API.
It will import short URLs but not their visits, as Kutt.it does not expose individual visits but aggregate information, which is coupled with its UI and uses relative times.
Shlink
It imports from another Shlink instance using the API v2. Useful if you want to migrate to a different host or change the database engine.
You will have to provide the instance's base URL and a valid API key.
It will import short URLs and all their visits. However, it won't be possible to recalculate the location for those visits, so make sure to calculate the locations on the original instance first, by running bin/cli visit:locate --retry.
Standard CSV
It parses a CSV file with the Long URL and Short code columns. It can optionally contain Domain, Title and Tags, being the latter a pipe-separated or comma-separated list of items (foo|bar|baz or foo,bar,baz).
It is also supported that a Short URL column is provided, in which case the Short code and Domain will be inferred from it if not explicitly provided.
Column names can have spaces and have any combination of upper and lowercase.
This method does not allow importing visits due to its one-dimensional nature.
Usage
The module register the short-url:import command, which can be used to import links from different sources.
This command requires the source from which to import to be provided:
`bin/cli short-url:import bitly`
The command will ask you some questions about how to import from this source, and then, once the data is there, it will invoke the Shlinkio\Shlink\Importer\ImportedLinksProcessorInterface service.
Requirements
This package expects some services to be registered as dependencies, as they need to be used by some provided tools.
Shlinkio\Shlink\Importer\ImportedLinksProcessorInterface: It has to resolve an object implementing the interface.Psr\Http\Client\ClientInterface: Required to be able to import from Bit.ly, YOURLS, Kutt.it or another Shlink instance.Psr\Http\Message\RequestFactoryInterface: Required to be able to import from Bit.ly, YOURLS, Kutt.it or another Shlink instance.